Skip to content

Commit

Permalink
Merge pull request #312 from singularity-energy/ben/template
Browse files Browse the repository at this point in the history
Add pull request template
  • Loading branch information
grgmiller authored Nov 22, 2023
2 parents 3b8c60b + 73dc256 commit 1ff871f
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/pull_request_template.md
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

0 comments on commit 1ff871f

Please sign in to comment.