Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (33 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

42 lines (33 loc) · 1.94 KB

Contributing to the project

Any input is welcome, such as:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Developed with Github

Code is hosted on GitHub to track issues and feature requests, as well as accept pull requests.

Please contribute through Pull Requests

Pull requests are the best way to propose changes to the codebase and are welcome:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the same license as the existing project

In short, when you submit code changes, your submissions are understood to be under the same license that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

GitHub issues are used to track public bugs. Report a bug by opening a new issue.

Write bug reports with detail, background, and sample code

Use a clear and descriptive title. Be specific and concise in your description of the issue. Include clear steps to reproduce the issue. Provide a clear explanation of what you expected to happen versus what actually happened. Include any relevant screenshots or other media that may help explain the problem. Provide information about your environment, such as your operating system or application version. If possible, try to isolate the issue to a specific code block or function.

Use a Consistent Coding Style

Where tools are used for styling and linting their configurations are kept in the project's pyproject.toml file. Ignores may be in inline comments.

References

This document was adapted from this example https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62