Skip to content

Commit

Permalink
docs(contributing): Actually describe the pre-commit setup
Browse files Browse the repository at this point in the history
  • Loading branch information
Wuestengecko committed Feb 6, 2024
1 parent a5dbc49 commit c92cf6a
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------
Expand Down

0 comments on commit c92cf6a

Please sign in to comment.