Skip to content

Commit 917f338

Browse files
authored
Merge pull request #66 from MunchLab/update-template
Add documentation and test updates to pull request template
2 parents dea5225 + 877394d commit 917f338

1 file changed

Lines changed: 19 additions & 3 deletions

File tree

.github/pull_request_template.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
<!--- Provide a general summary of your changes in the Title above -->
1+
# Pull Request
2+
3+
## Summary
4+
<!--- Provide a brief summary of your changes -->
25

36
## Description
47
<!--- Describe your changes in detail -->
@@ -17,11 +20,24 @@
1720
- [ ] Bug fix (non-breaking change which fixes an issue)
1821
- [ ] New feature (non-breaking change which adds functionality)
1922
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
23+
- [ ] Documentation update
24+
- [ ] Code refactoring
25+
- [ ] Performance improvement
26+
- [ ] Test improvement
2027

2128
## Checklist
2229
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
2330
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
2431
- [ ] My code follows the code style of this project. (`make clean`)
25-
- [ ] I have incremented the version number in the `pyproject.toml` file.
26-
- [ ] I have added tests to cover my changes.
32+
- [ ] I have incremented the version number in the `pyproject.toml` file (if applicable).
33+
- [ ] I have added tests to cover my changes (if applicable).
2734
- [ ] All new and existing tests passed. (`make tests`)
35+
- [ ] I have updated the documentation (if applicable).
36+
- [ ] My changes generate no new warnings.
37+
- [ ] I have added any necessary new dependencies to `pyproject.toml`.
38+
39+
## Additional Notes
40+
<!--- Add any additional notes, concerns, or questions for reviewers -->
41+
42+
## Screenshots (if applicable)
43+
<!--- Add screenshots to help explain your changes if they are visual in nature -->

0 commit comments

Comments
 (0)