You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: BUILDING.md
+18Lines changed: 18 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -85,3 +85,21 @@ Example:
85
85
86
86
If your port/build includes `arm-none-eabi-gdb-py`, consider using it instead, as it can be used for better register
87
87
debugging with https://github.com/bnahill/PyCortexMDebug
88
+
89
+
# Code Quality Checks
90
+
91
+
We apply code quality checks using pre-commit. Install pre-commit once per system with
92
+
93
+
python3 -mpip install pre-commit
94
+
95
+
Activate it once per git clone with
96
+
97
+
pre-commit --install
98
+
99
+
Pre-commit also requires some additional programs to be installed through your package manager:
100
+
101
+
* Standard Unix tools such as make, find, etc
102
+
* The gettext package, any modern version
103
+
* uncrustify version 0.71 (0.72 is also tested)
104
+
105
+
Some pre-commit quality checks require your active attention to resolve, others (such as the formatting checks of uncrustify) are made automatically and must simply be incorporated into your code changes by committing them.
0 commit comments