It's great you're here and reading this guide, because we need volunteers to help keep this project active and alive for the greater benefit of everyone!
TODO: Add links below to your repo's GitHub Issues and Discussions pages.
Here are some important resources:
- GitHub Issues - a place for bugs to be raised and feature requests made
- GitHub Discussions - a place to discuss ideas or real-world usage
TODO: Explain in detail what development standards must be adhered to when contributions are made.
You might include:
- Testing requirements
- Explanation of PR Checks
- What to expect from a PR reviewer/approver (such as expected time to response)
-
In order to help verify the authenticity of contributed code, we ask that your commits be signed. All commits must be signed off to show that you agree to publish your changes under the current terms and licenses of the project.
Here are some notes we found helpful in configuring a local environment to automatically sign git commits:
-
TODO: Explain code style, convention & quality standards (and any associated checks that will be run)
TODO: Explain in detail:
- How to run tests, including dependencies that might need installing or configuring
- Environmental configuration that may be required
- Consideration when writing tests (i.e. don't depend on X)
You might wish to break this out into different sub-sections if you have, for example, unit tests and integration tests with differing requirements.
Please send Pull Requests that:
- Have a singluar purpose, and that is backed by one or more GitHub Issues in this project
- Are clear
- Have appropriate test coverage for the Pull Requests purpose
- Meet our Code Style Convention (see above)
- Sign off your commits to show that you agree to publish your changes under the current terms and licenses of the project, and to indicate agreement with Developer Certificate of Origin (DCO).