Skip to content

Commit 3e69dd2

Browse files
docs: new pull request template (#3)
1 parent df5040d commit 3e69dd2

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.MD

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Closes: #(issue)
6+
7+
## Type of change
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue).
10+
- [ ] New feature (non-breaking change which adds functionality).
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected).
12+
- [ ] This change requires a documentation update.
13+
14+
## How Has This Been Tested?
15+
16+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration and a screenshot of your full execution.
17+
18+
- [ ] Test A
19+
- [ ] Test B
20+
21+
## Checklist
22+
23+
- [ ] Title of PR is according to convention.
24+
- [ ] My code follows the style guidelines of this project (**prettyfy**).
25+
- [ ] I have performed a self-review of my own code.
26+
- [ ] I have commented my code, particularly in hard-to-understand areas
27+
- [ ] I have made corresponding changes to the documentation.
28+
- [ ] My changes generate no new warnings.
29+
- [ ] I have added tests that prove my fix is effective or that my feature works.
30+
- [ ] New and existing tests pass locally with my changes.
31+
- [ ] Any dependent changes have been merged.

0 commit comments

Comments
 (0)