Mention flake8 and check-style.sh in CONTRIBUTING (#1567)

This commit is contained in:
cdyson37 2018-10-14 19:14:04 +01:00 committed by Wenzel Jakob
parent e76dff7751
commit 111b25b260

View File

@ -27,6 +27,8 @@ adhere to the following rules to make the process as smooth as possible:
do add value by themselves. do add value by themselves.
* Add tests for any new functionality and run the test suite (``make pytest``) * Add tests for any new functionality and run the test suite (``make pytest``)
to ensure that no existing features break. to ensure that no existing features break.
* Please run ``flake8`` and ``tools/check-style.sh`` to check your code matches
the project style. (Note that ``check-style.sh`` requires ``gawk``.)
* This project has a strong focus on providing general solutions using a * This project has a strong focus on providing general solutions using a
minimal amount of code, thus small pull requests are greatly preferred. minimal amount of code, thus small pull requests are greatly preferred.