- Please create an issue before creating a Pull Request
- Please ensure to use the
develop
branch as the base for all PRs - Please use the following Git commit message style
- Use the future tense ("Adds feature" not "Added feature")
- Use a "Fixes #xxx -" or "Closes #xxx -" prefix to auto-close the issue that your PR addresses
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- I have followed the guidelines in the Contributing document
- My changes are based off of the
develop
branch - My changes follow the coding style of this project
- My changes build without any errors or warnings
- My changes have been formatted and linted
- My changes include any required corresponding changes to the documentation
- My changes have been rebased and squashed to the minimal number (typically 1) of relevant commits
- My changes have a descriptive commit message with a short title, including a
Fixes $XXX -
orCloses #XXX -
prefix to auto-close the issue that your PR addresses