Add 'Running tests' section to CONTRIBUTING

This commit is contained in:
Mathieu Comandon 2018-12-21 23:38:35 -08:00
parent 54a6371647
commit 3413d59c65

View file

@ -78,6 +78,16 @@ If your patch does not require interactions with a GUI or external processes,
please consider adding unit tests for your code. Have a look at the existing
test suite in the `tests` folder to see what kind of features are tested.
Running tests
-------------
Be sure to test your changes thoroughly, never submit changes without running
the code. At the very least, run the test suite and check that nothing broke.
You can run the test suite by typing `make test` in the source directory.
In order to run the test, you'll need to install nosetests and flake8:
pip3 install nose flake8
Submitting your changes
-----------------------