Skip to content

Commit d3490e5

Browse files
authored
Update PR template (#12)
1 parent 02e11c9 commit d3490e5

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

.github/pull_request_template.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,20 @@
44
Select one: This pull request is...
55
- [ ] a bug fix: increment the patch version
66
- [ ] a small improvement: increment the minor version
7+
- [ ] a new feature: increment the minor version
78
- [ ] an incompatible (non-backwards compatible) API change: increment the major version
89

9-
## 1. Does this do what we want it to do?
10+
Please fill out either the "Small Change" or "Big Change" section, and delete the other.
11+
12+
## Small Change
13+
14+
- [ ] To merge, I will use "Squash and merge". That is, this change should be a single commit.
15+
16+
## Big Change
17+
18+
- [ ] 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).
19+
20+
### 1. Does this do what we want it to do?
1021

1122
Objectives:
1223
- Objective 1
@@ -18,7 +29,7 @@ Required:
1829
- [ ] Product Management: I have confirmed with the stakeholders that the objectives above are correct and complete.
1930
- [ ] Testing: I have considered likely and/or severe edge cases and have included them in testing.
2031

21-
## 2. Are the implementation details accurate & efficient?
32+
### 2. Are the implementation details accurate & efficient?
2233

2334
Required:
2435
- [ ] Logic: I have visually inspected the entire pull request myself.
@@ -27,12 +38,12 @@ Required:
2738
If applicable:
2839
- [ ] Dependencies: This pull request introduces a new dependency. I have discussed this requirement with at least one other team member. The dependency is noted in `zppy-interfaces/conda`, not just an `import` statement.
2940

30-
## 3. Is this well documented?
41+
### 3. Is this well documented?
3142

3243
Required:
3344
- [ ] Documentation: by looking at the docs, a new user could easily understand the functionality introduced by this pull request.
3445

35-
## 4. Is this code clean?
46+
### 4. Is this code clean?
3647

3748
Required:
3849
- [ ] Readability: The code is as simple as possible and well-commented, such that a new team member could understand what's happening.

0 commit comments

Comments
 (0)