Skip to content

Commit 98e6ae1

Browse files
authored
Add PR template (#347)
1 parent 6894798 commit 98e6ae1

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

.github/pull_request_template.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## Issue resolution
2+
- Closes #<ISSUE_NUMBER_HERE>
3+
4+
Select one: This pull request is...
5+
- [ ] a bug fix: increment the patch version
6+
- [ ] a small improvement: increment the minor version
7+
- [ ] an incompatible (non-backwards compatible) API change: increment the major version
8+
9+
## 1. Does this do what we want it to do?
10+
11+
Objectives:
12+
- Objective 1
13+
- Objective 2
14+
- ...
15+
- Objective n
16+
17+
Required:
18+
- [ ] Product Management: I have confirmed with the stakeholders that the objectives above are correct and complete.
19+
- [ ] Testing: I have added at least one automated test. Every objective above is represented in at least one test.
20+
- [ ] Testing: I have considered likely and/or severe edge cases and have included them in testing.
21+
22+
If applicable:
23+
- [ ] Testing: this pull request adds at least one new possible command line option. I have tested using this option with and without any other option that may interact with it.
24+
25+
## 2. Are the implementation details accurate & efficient?
26+
27+
Required:
28+
- [ ] Logic: I have visually inspected the entire pull request myself.
29+
- [ ] Logic: I have left GitHub comments highlighting important pieces of code logic. I have had these code blocks reviewed by at least one other team member.
30+
31+
If applicable:
32+
- [ ] 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 `zstash/conda`, not just an `import` statement.
33+
34+
## 3. Is this well documented?
35+
36+
Required:
37+
- [ ] Documentation: by looking at the docs, a new user could easily understand the functionality introduced by this pull request.
38+
39+
## 4. Is this code clean?
40+
41+
Required:
42+
- [ ] Readability: The code is as simple as possible and well-commented, such that a new team member could understand what's happening.
43+
- [ ] Pre-commit checks: All the pre-commits checks have passed.
44+
45+
If applicable:
46+
- [ ] Software architecture: I have discussed relevant trade-offs in design decisions with at least one other team member. It is unlikely that this pull request will increase tech debt.

0 commit comments

Comments
 (0)