Skip to content

Commit d44ee36

Browse files
committed
Documented use of black, pre-commit in contributing docs
1 parent 3d5c905 commit d44ee36

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

docs/contributing.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ contribute by making a fork, and submitting a PR on `GitHub
66
<https://github.com/python-parsy/parsy>`_.
77

88
We have a high standard in terms of quality. All contributions will need to be
9-
fully covered by unit tests and documentation. Code should be formatted
10-
according to pep8, and the formatting defined by the ``../.editorconfig`` file
11-
(see `EditorConfig <http://editorconfig.org/>`_).
9+
fully covered by unit tests and documentation.
1210

1311
To run the test suite::
1412

@@ -27,9 +25,18 @@ To build the docs, do::
2725
cd docs
2826
make html
2927

30-
We also require that `flake8 <http://flake8.pycqa.org/en/latest/>`_, `isort
31-
<https://github.com/timothycrosley/isort#readme>`_ and checkmanifest report zero
32-
errors (these are run by tox).
28+
We now have several linters and code formatters that we require use of,
29+
including `flake8 <http://flake8.pycqa.org/en/latest/>`_, `isort
30+
<https://github.com/timothycrosley/isort#readme>`_ and `black
31+
<https://github.com/psf/black>`_. These are most easily add by using `pre-commit
32+
<https://pre-commit.com/>`_:
33+
34+
* Install pre-commit globally e.g. ``pipx install pre-commit`` if you already
35+
have `pipx <https://github.com/pypa/pipx>`_.
36+
37+
* Do ``pre-commit install`` in the repo.
38+
39+
Now all the linters will run when you commit changes.
3340

3441
When writing documentation, please keep in mind Daniele Procida's `great article
3542
on documentation <https://www.divio.com/en/blog/documentation/>`_. To summarise,

0 commit comments

Comments
 (0)