From c92cf6a421e1414dcbc4988d44e8dcec95725146 Mon Sep 17 00:00:00 2001 From: Martin Lehmann Date: Tue, 6 Feb 2024 12:10:43 +0100 Subject: [PATCH] docs(contributing): Actually describe the pre-commit setup --- CONTRIBUTING.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0ee0770c0..06abb9b8b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -72,9 +72,17 @@ We additionally recommend that you set up your editor / IDE as follows. Quality controls ---------------- -We rely on pre-commit__ to perform basic quality control / self assessment. +We use the pre-commit__ framework to perform some basic code checks at commit +time. Before you commit your changes, make sure it is installed and set up, as +described in the `installation instructions`__: + +.. code:: bash + + pip install pre-commit + pre-commit install __ https://pre-commit.com/ +__ README.rst#installation Commit message format ---------------------