-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
## Issue resolution | ||
- Closes #<ISSUE_NUMBER_HERE> | ||
|
||
Select one: This pull request is... | ||
- [ ] a bug fix: increment the patch version | ||
- [ ] a small improvement: increment the minor version | ||
- [ ] an incompatible (non-backwards compatible) API change: increment the major version | ||
|
||
## 1. Does this do what we want it to do? | ||
|
||
Objectives: | ||
- Objective 1 | ||
- Objective 2 | ||
- ... | ||
- Objective n | ||
|
||
Required: | ||
- [ ] Product Management: I have confirmed with the stakeholders that the objectives above are correct and complete. | ||
- [ ] Testing: I have added at least one automated test. Every objective above is represented in at least one test. | ||
- [ ] Testing: I have considered likely and/or severe edge cases and have included them in testing. | ||
|
||
If applicable: | ||
- [ ] 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. | ||
|
||
## 2. Are the implementation details accurate & efficient? | ||
|
||
Required: | ||
- [ ] Logic: I have visually inspected the entire pull request myself. | ||
- [ ] 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. | ||
|
||
If applicable: | ||
- [ ] 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. | ||
|
||
## 3. Is this well documented? | ||
|
||
Required: | ||
- [ ] Documentation: by looking at the docs, a new user could easily understand the functionality introduced by this pull request. | ||
|
||
## 4. Is this code clean? | ||
|
||
Required: | ||
- [ ] Readability: The code is as simple as possible and well-commented, such that a new team member could understand what's happening. | ||
- [ ] Pre-commit checks: All the pre-commits checks have passed. | ||
|
||
If applicable: | ||
- [ ] 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. |