When contributing to this repository, please first discuss the change you wish to make via issue, email, 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.
- Please open an issue for any bugs or feature requests. If you are unsure if your issue is a bug or a feature request, please open an issue and we will help you determine the best course of action.
- Issues will be marked ready for work when they are ready to be worked on. If you would like to work on an issue that is not marked ready for work, please comment on the issue but do know a different path might be taken subsequently.
- If you are working on an issue, please assign yourself to it. If you are not sure if you want to work on an issue, please comment on the issue and we will help you determine the best course of action.
- Please branch off the main branch using
git checkout -b <my-initials/#issue-number-brief-description>. - Make your changes, and ensure that your code passes all tests. We prefer that you use small commits for each logical change with a descriptive commit message.
- Maintainers will be notified of your pull request and will review it. If you have any questions, please feel free to ask.
- Make sure you leave a good description of your changes in the pull request. This will help us understand your changes and make it easier for us to review them. Also please refernce the issue that this fixes in the description, eg
Fixes #1234. - Please follow our code of conduct in all your interactions with the project. Good discourse is always welcome and we view a healthy discourse on both PRs and issues as a sign of a healthy project.