doc: add a note on precommit hooks to CONTRIBUTING.rst

yt-project · Jul 2, 2020 · 084039c · 084039c
1 parent 6cb2d5a
commit 084039c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -747,6 +747,13 @@ error and warning list
 blacklist a large number of the full list of rules that are checked by
 ``flake8`` by default.
 
+.. note::
+
+    You may want to use our precommit hooks (install with ``pre-commit install``) to
+    automate all style checks (black, isort and flake8). This is a very quick way to check
+    for mistakes on every commit because only updated lines are inspected. Note that it
+    may take a little while the first time it is run.
+
 Source code style guide
 -----------------------