Skip to content

Latest commit

 

History

History
29 lines (17 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

29 lines (17 loc) · 1.3 KB

How to Contribute

Bug Reports

Our project isn't always perfect, but we strive to always improve on that work. Please report any bugs by filing an issue.

Feature Requests

We're always looking for suggestions to improve this project. If you have a suggestion for improving an existing feature, or would like to suggest a completely new feature, please file an issue.

Pull Requests

Along with our desire to hear your feedback and suggestions, we're also interested in accepting direct assistance in the form of new code or documentation.

We ask that you please file a bug report or feature request first to make sure your change isn't already being worked on, then open a pull request with the code change.

Testing

Tests will be run automatically with each pull request, or you can run them locally with pytest or tox. Make sure you're in an appropriate virtual environment before running the above commands.

$ pytest
$ tox

With tox a unit test coverage HTML page will appear within the .htmlcov directory of your workspace root directory.