pre-commit docs #2 #14032

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
-exclude: 'tests/.*'
+exclude: '(tests|tools/contributed|tools/sumolib/scenario)/.*'
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v3.2.0

docs/web/docs/Developer/GitStuff.md

@@ -6,7 +6,7 @@ title: GitStuff
 
 ## Resolve LF status error
 
-Occasionally, when adding files with different line endings to the
+Occasionally, when adding binary files or files with different line endings to the
 repository, a working copy may enter a state with changes that can not
 be reverted (by stash or checkout).
 
@@ -26,3 +26,24 @@ git reset --hard
 ## Plot number of issues over time
 
 https://sumo.dlr.de/ghis/
+
+
+## Git commit hooks
+
+We are using [pre-commit](https://pre-commit.com). To enable it for your checkout it should suffice to do
+the following calls in your git repo:
+
+```
+pip install pre-commit
+pre-commit install
+```
+
+It will enable checks for trailing whitespace, LF at the end of every file as well as parsable yaml files
+and a maximum file size of 500kb. Every commit which does not pass the tests will fail.
+Checks are not performed for the tests directory. Whitespace errors will
+be repaired automatically, so that you can issue another commit right afterwards. More checks will probably be added later.
+If you want to run the checks manually without committing,
+you can just run `pre-commit`. If you want to check all files (not only the ones which will be part of the commit)
+run `pre-commit run --all`.
+
+The configuration can be found in `.pre-commit-config.yaml`.