Skip to content

Commit cc609d4

Browse files
committed
docs: describe use of pre-commit hooks
1 parent fe34072 commit cc609d4

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

.github/CONTRIBUTING.rst

+9
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,15 @@ Ready to contribute? Here's how to set up cobrapy for local development.
105105
106106
tox --parallel
107107
108+
We also provide some `git pre-commit hooks <https://pre-commit.com/>`_ for
109+
your convenience. They run our linting steps and will ensure that your
110+
contributions pass linting with every commit that you make. When you want to
111+
use them, run the following commands.
112+
113+
.. code-block:: console
114+
115+
pip install pre-commit
116+
pre-commit install
108117
109118
7. Push your branch to GitHub.
110119

0 commit comments

Comments
 (0)