-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #312 from singularity-energy/ben/template
Add pull request template
- Loading branch information
Showing
1 changed file
with
28 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,28 @@ | ||
### Purpose | ||
What is the larger goal of this change? | ||
|
||
### What the code is doing | ||
How is the purpose executed? | ||
|
||
### Testing | ||
How did you test this change (unit/functional testing, manual testing, etc.)? | ||
|
||
### Where to look | ||
* It's helpful to clarify where your new code lives if you moved files around or there could be confusion/ | ||
|
||
* What files are most important? | ||
|
||
### Usage Example/Visuals | ||
How the code can be used and/or images of any graphs, tables or other visuals (not always applicable). | ||
|
||
### Review estimate | ||
How long will it take for reviewers and observers to understand this code change? | ||
|
||
### Future work | ||
What issues were identified that are not being addressed in this PR but should be addressed in future work? | ||
|
||
### Checklist | ||
- [ ] Update the documentation to reflect changes made in this PR | ||
- [ ] Format all updated python files using `black` | ||
- [ ] Clear outputs from all notebooks modified | ||
- [ ] Add docstrings and type hints to any new functions created |