From 084039ced2a1b0d23700ba7e08e57b308b53ab59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Robert?= Date: Tue, 23 Jun 2020 12:57:41 +0200 Subject: [PATCH] doc: add a note on precommit hooks to CONTRIBUTING.rst --- CONTRIBUTING.rst | 7 +++++++ 1 file changed, 7 insertions(+) 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 -----------------------