From 7771fa8a76d1bcc4d382b3f9ea32788cf5133a4d Mon Sep 17 00:00:00 2001 From: mrava87 Date: Wed, 29 Dec 2021 13:06:35 +0300 Subject: [PATCH] Added installation instructions for pre-commit --- docs/source/installation.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index b0e43a0f..9cae6eeb 100755 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -139,6 +139,19 @@ To ensure that everything has been setup correctly, run tests: Make sure no tests fail, this guarantees that the installation has been successfull. +Finally, to ensure consistency in the coding style of our developers we rely on +`pre-commit `_ to perform a series of checks when you are +ready to commit and push some changes. This is accomplished by means of git hooks +that have been configured in the ``.pre-commit-config.yaml`` file. + +In order to setup such hooks in your local repository, run: + +.. code-block:: bash + + >> pre-commit install + +Later on, ``pre-commit`` will automatically run for you and propose additional stylistic changes to your commits. + If using Conda environment, always remember to activate the conda environment every time you open a new *bash* shell by typing: