added note on githooks in coding guidelines

blipper · Aug 29, 2018 · 5e264be · 5e264be
1 parent ee95034
commit 5e264be
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/CODING_GUIDELINES.txt b/CODING_GUIDELINES.txt
@@ -7,3 +7,11 @@ coding guidelines can be here:
 
 	https://llvm.org/docs/CodingStandards.html
 
+In addition, the pre-commit script in githooks/ has to be copied into the 
+./git/hooks/ directory:
+
+	$ cp githooks/pre-commit .git/hooks/
+
+The script will run some useful clang-tidy checks as well as clang-format over
+the entire code base just before your changes are committed in order to reduce
+the number of unnecessary merge conflicts and to unify the code base.