albertaloop / T_SWE_2019_2020

Software for AlbertaLoop's first-generation pod.

MIT License

3 stars 1 forks source link

Add pre-commit hooks #60

Closed mbardwell closed 2 years ago

mbardwell commented 2 years ago

Summary

Use pre-commit to automatically lint repository. This ensures code standardisation.

pre-commit: init and perform initial sweep
- had to exclude CMSIS directory. We should make it a submodule so it can be ignore naturally
- note devs have to pip install pre-commit from now on
- note if you notice the clang-format and cpplint hooks are fighting, use .clang-format to adjust clang's settings to conform with cpplint
readme: update with pre-commit install info
readme: move GUI info to GUI README

Test

Repository automatically linted as expected

mbardwell commented 2 years ago

Ready for merge @Iyury1