Skip to content

Commit 0fb1996

Browse files
authored
Further PR template updates (#360)
1 parent 9c047ad commit 0fb1996

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

.github/pull_request_template.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
## Issue resolution
1+
## Summary
2+
3+
Objectives:
4+
- Objective 1
5+
- Objective 2
6+
- ...
7+
- Objective n
8+
9+
Issue resolution:
210
- Closes #<ISSUE_NUMBER_HERE>
311

412
Select one: This pull request is...
@@ -7,24 +15,20 @@ Select one: This pull request is...
715
- [ ] a new feature: increment the minor version
816
- [ ] an incompatible (non-backwards compatible) API change: increment the major version
917

10-
Please fill out either the "Small Change" or "Big Change" section, and delete the other.
18+
Please fill out either the "Small Change" or "Big Change" section (the latter includes the numbered subsections), and delete the other.
1119

1220
## Small Change
1321

1422
- [ ] To merge, I will use "Squash and merge". That is, this change should be a single commit.
23+
- [ ] Logic: I have visually inspected the entire pull request myself.
24+
- [ ] Pre-commit checks: All the pre-commits checks have passed.
1525

1626
## Big Change
1727

1828
- [ ] To merge, I will use "Create a merge commit". That is, this change is large enough to require multiple units of work (i.e., it should be multiple commits).
1929

2030
### 1. Does this do what we want it to do?
2131

22-
Objectives:
23-
- Objective 1
24-
- Objective 2
25-
- ...
26-
- Objective n
27-
2832
Required:
2933
- [ ] Product Management: I have confirmed with the stakeholders that the objectives above are correct and complete.
3034
- [ ] Testing: I have added at least one automated test. Every objective above is represented in at least one test.

0 commit comments

Comments
 (0)