Contributions to Scour are welcome, feel free to create a pull request!
In order to be able to merge your PR as fast as possible please try to stick to the following guidelines.
TL;DR (if you now what you're doing) – Always run
make checkbefore creating a PR to check for common problems.
The Scour project tries to follow the coding conventions described in PEP 8 - The Style Guide for Python Code. While there are some inconsistencies in existing code (e.g. with respect to naming conventions and the usage of globals), new code should always abide by the standard.
To quickly check for common mistakes you can use flake8. Our Makefile has a convenience target with the correct options:
make flake8In order to check functionality of Scour and prevent any regressions in existing code a number of tests exist which use the unittest unit testing framework which ships with Python. You can quickly run the tests by using the Makefile convenience target:
make testThese tests are run automatically on all PRs using TravisCI and have to pass at all times! When you add new functionality you should always include suitable tests with your PR (see test_scour.py).
To ensure that all possible code conditions are covered by a test you can use coverage. The Makefile convenience target automatically creates an HTML report in htmlcov/index.html:
make coverageThese reports are also created automatically by our TravisCI builds and are accessible via Codecov