diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f77e890b01b..277d3632a4c 100644 --- 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 -----------------------