Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.59 KB

CONTRIBUTING.rst

File metadata and controls

43 lines (27 loc) · 1.59 KB
Raw

Development and Contributing

All contributions are very welcome! You can contribute in many ways:

  • Join the python code quality mailing list and answer questions.
  • Report bugs on the GitHub issue tracker.
  • Submit pull requests on the GitHub repository. Ideally make a pull request to the develop branch, as I prefer to keep the master branch the same as the most recent release on PyPI. If you do this, be sure to add yourself to the CONTRIBUTORS.rst file too!

Code Quality

As a code quality testing tool, it makes sense to strive to be a good example of good code! To that end, prospector is checked by Landscape <https://landscape.io>_ and ideally when making a pull request, please take note of any decreases in quality.

Additionally, there is a pre-commit configuration to prevent various small problems before they are committed. Check the site for more information but the short version is:

pip install pre-commit
pre-commit install

Tests

There are not a huge number of tests right now, as most of the code in Prospector is handling the output of other tools. However, please do run them before submitting a pull request:

pytest

Prospector targets Python 3.6, 3.7, 3.8 and 3.9. You can use tox to test this locally, and all tests are run with Github Actions.