Thanks for your interest in contributing to the project! Below are some guidelines that you should follow in addition the Code of Conduct.
If you have discovered a bug or defect in the software contained in this repository, open an issue. Please be sure to include as much detail as possible including:
- What the defect is
- Any potential suggestions of a solution for the defect
- Any configuration details you can share
- Version of this software being used
- Installation method used
This software is very narrowly focused and should likely be considered feature complete.
Notable exceptions would be if any of the dependencies change. Especially any of the following:
Before undertaking any significant effort on anything in this repository, it should be discussed first. Please participate in that discussion in the applicable issue or PR, or create an issue.
Beyond that, please ensure that as part of any work you:
- Sign your commits
- Add tests where possible and necessary
- Ensure that any new changes don't break tests, or fix the broken tests as necessary
If you believe you have identified a security issue in the project, please do not create a public issue. Instead, report any potential vulnerabilities on the security page of the repository. You may also email the maintainer of this repository directly at [email protected].
You will receive acknowledgement of the report right away. I will commit to triaging and remediating the issue as soon as possible.
Once any discovered vulnerabilities are repaired, you will be publicly credited for the discovery.