Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 3.24 KB

Contribution Guidelines

If you want to contribute to this repository, please first discuss your desired changes in an issue (especially before opening a pull request).

Please follow the code of conduct in all interactions with this repository.

How can I Contribute?

Report a Bug

  • Bugs are reported as GitHub Issues.
  • Please make sure that there is no issue for the bug already, to avoid duplicates.
  • Provide a concise title and an precise and clear description of the bug.
  • Describe the exact steps to reproduce the bug and include any relevant information such as version numbers.

Suggest Enhancements

  • Enhancements suggestion are tracked as GitHub Issues.
  • If there is already an issue regarding the desired or a similar enhancement, please discuss the details there to avoid duplicates.
  • Provide a concise title and an precise and clear description of the enhancement.

Open a Pull Requests

  • Added or modified code is properly formatted (PEP 8 Style Guide), documented (docstrings according to the Google Python Style Guide) and tested.
  • The issue resolved by a PR is clearly referenced, preferably by using a keyword.
  • All code, comments, documentation, PR descriptions etc. are written exclusively in English.
  • All dependencies are listed in Pipfile and Pipfile.lock.
  • Commit messages use the imperative mood, have a meaningful, capitalized subject line with maximum 50 characters and do not end with a period.

Testing

This project uses the unittest module for testing. The command for testing is specified in .coveragerc. You can run it from the project root using:

$ coverage run

Use $ coverage report for a report on testing coverage.