Skip to content

Latest commit

 

History

History
17 lines (12 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

17 lines (12 loc) · 1.27 KB
Raw

Contributing Guidelines :

Contributions can be bug fixes, documentation updates, minor patches, feature requests etc. Before contributing ensure you've read and understood the documentation.

  • Open a new issue first, explaining the problem.

    • If you're reporting a bug, please include steps (or code) to reproduce the bug.
    • If you're issuing a feature request, please mention why it will be useful or the use case it solves.
    • If you intend to implement the new feature request OR fix a bug yourself, then give a brief outline of the proposed solution.

  • Fork the main branch and make your changes. Ensure that the new code is formatted with black

  • You can issue a new pull request to the main branch that closes the issue after you've been assigned.

    • Any non-trivial pull request without having opened an earlier issue will be closed.
    • Large (or new feature) pull requests must be accompanied with relevant tests if necessary.

  • Please be patient, respectful and inclusive while commenting on issues and pull requests