When contributing to this repository, please first discuss the change you wish to make via an issue, in our slack community, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with 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, goes 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 generally should have a regression-test added to ensure it isn't reintroduced.
- New features must be documented. Please read this for details on how to write documentation.
- If there's 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, re-trigger the CI until your pull-request pass, and feel free to file a ticket about the spurious test.
- Make sure you follow up any feedback to get your pull-request merged.
- If the pull-request is against
master, you may merge once the pull-request have 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