diff --git a/doc/contributing.rst b/doc/contributing.rst index b032fbd..7367f4c 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -4,9 +4,13 @@ Contributing If you're submitting patches to pagure, please observe the following: - Check that your python code is `PEP8-compliant - `_. There is a `pep8 tool - `_ that can automatically check - your source. + `_. There is a `flake8 tool + `_ that automatically check the sources as + part of the tests. + +- We run the source code through `black `_ + as part of the tests, so you may have to do some adjustments or run it + yourself (which is simple: ``black /path/to/pagure``). - Check that your code doesn't break the test suite. The test suite can be run using the ``runtests.sh`` shell script at the top of the sources.