Skip to content

Commit 1b72b78

Browse files
committed
add pr template
1 parent 015d196 commit 1b72b78

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

.github/pull_request_template.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
Brief description of the changes introduced by this PR.
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+
- [ ] Performance improvement
16+
- [ ] Code refactoring
17+
- [ ] Test improvements
18+
19+
## Related Issues
20+
21+
Fixes #(issue number)
22+
Closes #(issue number)
23+
Relates to #(issue number)
24+
25+
## Changes Made
26+
27+
- [ ] Change 1
28+
- [ ] Change 2
29+
- [ ] Change 3
30+
31+
## Testing
32+
33+
- [ ] I have added tests that prove my fix is effective or that my feature works
34+
- [ ] New and existing unit tests pass locally with my changes
35+
- [ ] I have tested this change manually
36+
37+
### Test Instructions
38+
39+
Please describe how reviewers can test your changes:
40+
41+
1. Step 1
42+
2. Step 2
43+
3. Step 3
44+
45+
## Screenshots (if applicable)
46+
47+
Add screenshots to help explain your changes.
48+
49+
## Checklist
50+
51+
- [ ] My code follows the style guidelines of this project
52+
- [ ] I have performed a self-review of my own code
53+
- [ ] I have commented my code, particularly in hard-to-understand areas
54+
- [ ] I have made corresponding changes to the documentation
55+
- [ ] My changes generate no new warnings
56+
- [ ] I have added tests that prove my fix is effective or that my feature works
57+
- [ ] New and existing unit tests pass locally with my changes
58+
- [ ] Any dependent changes have been merged and published in downstream modules
59+
- [ ] I have run `black .`, `isort .`, and `flake8` and fixed any issues
60+
- [ ] Database migrations are included (if applicable)
61+
62+
## Additional Notes
63+
64+
Add any additional notes or context about the PR here.

0 commit comments

Comments
 (0)