Skip to content

Commit 7c40eec

Browse files
Create pull request template for contributions
Added a pull request template to guide contributors in providing necessary information about their changes.
1 parent 18a24e1 commit 7c40eec

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

.github/pull_request_template.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Description
2+
3+
Please include a summary of the changes and the related issue. Include relevant motivation and context.
4+
5+
Fixes #(issue)
6+
7+
## Type of Change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
- [ ] Code refactoring
16+
- [ ] Performance improvement
17+
- [ ] Test addition or update
18+
19+
## How Has This Been Tested?
20+
21+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
22+
23+
- [ ] Test A
24+
- [ ] Test B
25+
26+
**Test Configuration**:
27+
* Language/Framework version:
28+
* Operating System:
29+
30+
## Checklist
31+
32+
- [ ] My code follows the style guidelines of this project
33+
- [ ] I have performed a self-review of my own code
34+
- [ ] I have commented my code, particularly in hard-to-understand areas
35+
- [ ] I have made corresponding changes to the documentation
36+
- [ ] My changes generate no new warnings
37+
- [ ] I have added tests that prove my fix is effective or that my feature works
38+
- [ ] New and existing unit tests pass locally with my changes
39+
- [ ] Any dependent changes have been merged and published
40+
41+
## Screenshots (if applicable)
42+
43+
Add screenshots to help explain your changes.
44+
45+
## Additional Notes
46+
47+
Add any other context about the pull request here.

0 commit comments

Comments
 (0)