When contributing to this repository, please first discuss the change you wish to make, via issue or email ([email protected]), with the owners of this repository.
Please note we have a code of conduct, please follow it in all your interactions with the project.
This repo uses GitHub to manage reviews of pull requests.
Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on it. This is to prevent duplicated efforts from contributors on the same issue.
If you have a trivial fix or improvement, go ahead and create a pull request, and submit it for review.
-
Branch from the main branch and, if needed, rebase to the current main branch before submitting your pull request. If it doesn't merge cleanly with main you may be asked to rebase your changes.
-
Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).
-
If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment. You can also send a message to [email protected].
-
Add tests relevant to the fixed bug or new feature.