If you want to contribute to this repository, please first discuss the changes you want to make with the repository's owners, for example via an issue or on Slack.
This project has a code of conduct. Please follow it in all your interactions related to the project.
We also have a contributor license agreement, that we require contributors to sign in order to have their changes considered for inclusion.
- Features should generally be pulled against the
masterbranch. Bug fixes, depending on the urgency and risk, go either against an active release branch, ormaster. - Make sure the code follows our coding style.
- New features should have tests added, ensuring the feature does not silently break. Bug fixes should generally have regression tests added to ensure they're not reintroduced later.
- New features must be documented. Please read this for details on how to write documentation.
- If there are any functional changes, update CHANGELOG.md with a brief explanation.
- Ensure that tests pass locally before sending a pull request.
- Make sure your pull request passes the required CI (continuous integration). If there's a spurious error, retrigger the CI until your pull request passes, and feel free to file a ticket about the spurious test.
- Make sure you follow up on any feedback to get your pull request merged.
- If the pull request is against
master, you may merge once the pull request has been approved by a project member and passed CI, if you have the permissions needed. Otherwise, ping the project member who approved the pull request. Pull requests against release branches should be done by the release manager (if you're unsure who this is, contact the project team).
Please read and adhere to our Code of Conduct