When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before working on a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
- Use PRs to fix issues. New features are discouraged as they bring more maintenance burden over time.
- Discuss the change you wish to make with the owners of this repository before raising a PR. If you do not discuss it beforehand, your PR might end up being rejected and your work will be lost.
- Please ensure your proposal will not significantly change current functionality or bring along breaking changes.
- PRs only consisting of typo fixes (or other automated contributions), will not be accepted.
- Do not add any dependencies, libraries or external codes to the project. All the code submitted should be authored by you.
- Avoid refactors. The changes should be succint and fix a specific issue with the least code possible.
- Document your changes thoroughly.
- Ensure that none of the tests fail.
- Be reactive to any comments, reviews or change requests entered in your pull request.
- It's up to the maintainers discretion whether the PR is accepted or rejected. Remember, the maintainer will have to maintain the code you've added (and fix any issues filed about it) for the years to come! In case of a rejection, the maintainer will explain the reasons guiding the decision.
Thank you for your contributions!