update: update CONTRIBUTING.md

dylanljones · May 13, 2022 · e1b7cbe · e1b7cbe
1 parent 54ce7ae
commit e1b7cbe
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,6 +2,18 @@
 
 Thank you for contributing to `lattpy` :tada:
 
+## Pre-commit Hooks
+
+We are using the [pre-commit framework](https://pre-commit.com/) to automatically run
+some checks and the [Black code formatter](https://github.com/psf/black) at commit time.
+This ensures that every commit fulfills the basic requirements to be mergeable and
+follows the coding style of the project.
+
+The pre-commit hooks can be installed via
+````sh
+$ pre-commit install
+pre-commit installed at .git/hooks/pre-commit
+````
 
 ## Commit Message Format