-
Notifications
You must be signed in to change notification settings - Fork 88
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update PULL_REQUEST_TEMPLATE.md (#41)
- Loading branch information
Showing
1 changed file
with
13 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,22 @@ | ||
Make sure you have checked **all** steps below. | ||
### Summary of Changes | ||
|
||
### Title | ||
|
||
- [ ] My PR Title addresses the issue accurately and concisely. | ||
- Example: "Updates the version of Flask to v1.0.2" | ||
- In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x). | ||
|
||
### Description | ||
|
||
- [ ] Here are some details about my PR, including screenshots of any UI changes: | ||
_Include a summary of changes then remove this line_ | ||
|
||
### Tests | ||
|
||
- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason: | ||
|
||
### Commits | ||
|
||
- [ ] I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)": | ||
1. Subject is separated from body by a blank line | ||
1. Subject is limited to 50 characters (not including Jira issue reference) | ||
1. Subject does not end with a period | ||
1. Subject uses the imperative mood ("add", not "adding") | ||
1. Body wraps at 72 characters | ||
1. Body explains "what" and "why", not "how" | ||
_What tests did you add or modify and why? If no tests were added or modified, explain why. Remove this line_ | ||
|
||
### Documentation | ||
|
||
_What documentation did you add or modify and why? Add any relevant links then remove this line_ | ||
|
||
### CheckList | ||
Make sure you have checked **all** steps below to ensure a timely review. | ||
- [ ] PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2" | ||
- In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x). | ||
- [ ] PR includes a summary of changes. | ||
- [ ] PR adds unit tests, updates existing unit tests, __OR__ documents why no test additions or modifications are needed. | ||
- [ ] In case of new functionality, my PR adds documentation that describes how to use it. | ||
- All the public functions and the classes in the PR contain docstrings that explain what it does | ||
|
||
### Code Quality & Coverage | ||
|
||
- [ ] Passes `make test` | ||
- [ ] PR passes `make test` | ||
- [ ] I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)" |