2021-07-20 15:31:45 +00:00
|
|
|
## Commit Checklist
|
|
|
|
|
|
2021-07-20 15:52:33 +00:00
|
|
|
Thank you for creating a pull request! To help us review / merge this can you make sure that your PR adheres as much as possible to the following.
|
2021-07-20 15:31:45 +00:00
|
|
|
|
|
|
|
|
### The Basics
|
|
|
|
|
|
2021-07-20 15:52:33 +00:00
|
|
|
- Commit is a single logical unit of work, only use multiple commits if doing different tasks
|
|
|
|
|
- Commit does not include commented out code or unneeded files
|
2021-07-20 15:31:45 +00:00
|
|
|
- rebase of main branch
|
|
|
|
|
|
|
|
|
|
### The Content
|
|
|
|
|
|
2021-07-20 15:52:33 +00:00
|
|
|
- Must include testing for bug or feature
|
|
|
|
|
- Must include appropriate documentation changes if it is introducing a new feature or changing existing functionality
|
|
|
|
|
- Must pass existing test suites
|
2021-07-20 15:31:45 +00:00
|
|
|
|
|
|
|
|
### The Commit Message
|
|
|
|
|
|
2021-07-20 15:52:33 +00:00
|
|
|
- Short meaningful description (ex: remove deprecated steps)
|
|
|
|
|
- Uses the imperative, present tense: "change", not "changed" or "changes"
|
|
|
|
|
- Includes motivation for the change, and contrasts its implementation with the previous behavior
|
2021-07-20 15:31:45 +00:00
|
|
|
|
|
|
|
|
### The Pull Request
|
|
|
|
|
|
2021-07-20 15:52:33 +00:00
|
|
|
- What is the reason for this change
|
|
|
|
|
- Example usage of the failure for a bug, or configuration and expected output for a feature
|
|
|
|
|
- Steps to test the change
|
