Skip to content

Commit 86ea652

Browse files
authored
Update PULL_REQUEST_TEMPLATE.md (#23)
### Summary of Changes This PR consolidates the pull request template initially added by @verdan. It's been requested to be updated across all of our repos: amundsen-io/amundsenfrontendlibrary#125 (comment) ### Tests Unit tests not required for template changes. ### Documentation Documentation not required for template changes. ### 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 - [ ] 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/)"
1 parent a49d685 commit 86ea652

File tree

1 file changed

+13
-25
lines changed

1 file changed

+13
-25
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,22 @@
1-
Make sure you have checked **all** steps below.
1+
### Summary of Changes
22

3-
### Title
4-
5-
- [ ] My PR Title addresses the issue accurately and concisely.
6-
- Example: "Updates the version of Flask to v1.0.2"
7-
- 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).
8-
9-
### Description
10-
11-
- [ ] Here are some details about my PR:
3+
_Include a summary of changes then remove this line_
124

135
### Tests
146

15-
- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
16-
17-
### Commits
18-
19-
- [ ] 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/)":
20-
1. Subject is separated from body by a blank line
21-
1. Subject is limited to 50 characters (not including Jira issue reference)
22-
1. Subject does not end with a period
23-
1. Subject uses the imperative mood ("add", not "adding")
24-
1. Body wraps at 72 characters
25-
1. Body explains "what" and "why", not "how"
7+
_What tests did you add or modify and why? If no tests were added or modified, explain why. Remove this line_
268

279
### Documentation
2810

11+
_What documentation did you add or modify and why? Add any relevant links then remove this line_
12+
13+
### CheckList
14+
Make sure you have checked **all** steps below to ensure a timely review.
15+
- [ ] PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2"
16+
- 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).
17+
- [ ] PR includes a summary of changes.
18+
- [ ] PR adds unit tests, updates existing unit tests, __OR__ documents why no test additions or modifications are needed.
2919
- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
3020
- All the public functions and the classes in the PR contain docstrings that explain what it does
31-
32-
### Code Quality & Coverage
33-
34-
- [ ] Passes `make test`
21+
- [ ] PR passes `make test`
22+
- [ ] 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/)"

0 commit comments

Comments
 (0)