We welcome community contributions with issues and pull requests (PRs). Please be sure to read and follow our Code of Conduct.
[Link to Code of Conduct]
Navigate to issues, and submit an issue with the template below. For feedback and discussions, please use the Discussion tab.
Before filing a new issue, please search the list of issues to make sure it does not already exist...
Good bug reports make it easier for maintainers to verify and root cause the underlying problem...
Project maintainers will merge accepted code changes from contributors. All contributors should include unit tests for their changes, if applicable. Please see our Testing Guidelines-TODO for more information.
Before you start contributing, please ensure that your development environment meets the following requirements:
[List of requirements and setup steps]
DO's:
- DO follow the standard coding conventions...
DON'Ts:
[List of practices to avoid]
Contributions must maintain API signature and behavioral compatibility...
We use and recommend the following workflow:
- Create an issue for your work...
- Create a personal fork of the repository on GitHub...
- In your fork, create a branch off of main (
git checkout -b mybranch)... - Make and commit your changes to your branch.
- Add new tests corresponding to your change, if applicable.
- Create a PR against the repository's main branch...
- Wait for feedback or approval of your changes from the code maintainers.
- When area owners have signed off, and all checks are green, your PR will be merged...
Examples of trivial changes include minor documentation updates or changes in comments.
Upon submission of your PR, it will be reviewed by [number] of reviewers. The review process typically takes [time frame], but this can vary depending on the complexity of the changes and the current workload of the reviewers.
The continuous integration (CI) system will automatically perform the required builds and run tests...