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.
If you’ve got an idea or suggestion you can:
- Email [email protected] putting the repository name in the subject line.
- Create a GitHub issue.
When raising bugs, please explain the issue in reasonable detail and provide a guide on how to replicate it.
When describing the bug, it's useful to follow the format:
- What you did
- What you expected to happen
- What happened
Please raise feature requests as issues before contributing any code.
Raising an issue ensures they are openly discussed and before spending any time on them.
Follow the guidelines on Semantic Versioning for assigning version numbers.
Change versions in a commit of their own, in a pull request of their own. This commit alerts team members to the new version and allows for last-minute scrutiny before the new version is released. Also, by raising a separate pull request, we avoid version number conflicts between feature branches.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move thing to..." not "Moves thing to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- Use a pull request template