Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 1.57 KB

CONTRIBUTING.rst

File metadata and controls

53 lines (36 loc) · 1.57 KB

Contributing

  1. Contributing Guide
  2. Running tests

Contributing guide

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.
  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
  • Make sure that the tests are passing. You can see the builds here

Do you intend to add a new feature or change an existing one?

  • Suggest your change by creating a issue with the enhancement label.

Do you fix the bug, but don't know how to write tests?

  • No problem. Submit a pull request and someone will help you writing the tests.

Running tests

pip install -r requirements/develop.txt
tox