You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+15-4Lines changed: 15 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,20 @@
4
4
Select one: This pull request is...
5
5
-[ ] a bug fix: increment the patch version
6
6
-[ ] a small improvement: increment the minor version
7
+
-[ ] a new feature: increment the minor version
7
8
-[ ] an incompatible (non-backwards compatible) API change: increment the major version
8
9
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?
10
21
11
22
Objectives:
12
23
- Objective 1
@@ -18,7 +29,7 @@ Required:
18
29
-[ ] Product Management: I have confirmed with the stakeholders that the objectives above are correct and complete.
19
30
-[ ] Testing: I have considered likely and/or severe edge cases and have included them in testing.
20
31
21
-
## 2. Are the implementation details accurate & efficient?
32
+
###2. Are the implementation details accurate & efficient?
22
33
23
34
Required:
24
35
-[ ] Logic: I have visually inspected the entire pull request myself.
@@ -27,12 +38,12 @@ Required:
27
38
If applicable:
28
39
-[ ] 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.
29
40
30
-
## 3. Is this well documented?
41
+
###3. Is this well documented?
31
42
32
43
Required:
33
44
-[ ] Documentation: by looking at the docs, a new user could easily understand the functionality introduced by this pull request.
34
45
35
-
## 4. Is this code clean?
46
+
###4. Is this code clean?
36
47
37
48
Required:
38
49
-[ ] 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