Skip to content

Commit

Permalink
Merge pull request #282 from mrava87/master
Browse files Browse the repository at this point in the history
Added installation instructions for pre-commit
  • Loading branch information
mrava87 authored Dec 29, 2021
2 parents bbe6837 + 7771fa8 commit 566456d
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://pre-commit.com>`_ 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:

Expand Down

0 comments on commit 566456d

Please sign in to comment.