Add pre-commit setup to the Setup and Building chapter (#1306)

Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Erlend E. Aasland <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>

Author: 4 people

getting-started/pull-request-lifecycle.rst

@@ -108,7 +108,12 @@ You should have already :ref:`set up your system <setup>`,
 
   (Learn more about :ref:`good-commits`)
 
-* Then push your work to your GitHub fork::
+* If your code isn't linted correctly, :ref:`pre-commit <install-pre-commit>`
+  will block the commit with an error message, for example::
+
+     Doc/library/stdtypes.rst:5718: No newline at end of file. (missing-final-newline)
+
+* Once all linting errors have been fixed, you can push your work to your GitHub fork::
 
      git push origin <branch-name>
 

getting-started/setup-building.rst

@@ -130,6 +130,18 @@ affected files as described below.)
 Patches for the documentation can be made from the same repository; see
 :ref:`documenting`.
 
+.. _install-pre-commit:
+
+Install pre-commit as a Git hook
+--------------------------------
+
+To make sure your code is linted correctly, we recommend setting up
+`pre-commit <https://pre-commit.com#installation>`_ as a Git hook::
+
+   $ pre-commit install --allow-missing-config
+   pre-commit installed at .git/hooks/pre-commit
+
+Now pre-commit will run automatically on ``git commit``.
 
 .. _compiling: