Skip to content

Commit 2f5c7a3

Browse files
docs: Add pull request template
This template provides a comprehensive structure for PRs including: - Clear description and issue linking - Type of change classification - Implementation details - Testing information - Extensive checklist for code quality, documentation, and testing - Space for screenshots and additional notes This follows the PR guidelines defined in CLAUDE.md.
1 parent bf78b83 commit 2f5c7a3

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

.github/pull_request_template.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Pull Request
2+
3+
## Description
4+
Please include a summary of the changes and which issue is fixed. Include relevant motivation and context.
5+
6+
Fixes #(issue number)
7+
8+
## Type of Change
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 style update (formatting, renaming)
16+
- [ ] ♻️ Refactoring (no functional changes)
17+
- [ ] ⚡ Performance improvement
18+
- [ ] ✅ Test addition or update
19+
- [ ] 🔧 Configuration change
20+
21+
## Implementation Details
22+
Describe the technical details of your implementation:
23+
- Key changes made
24+
- New files/modules added
25+
- Modified components
26+
- Algorithms or approaches used
27+
28+
## Testing
29+
Please describe the tests that you ran to verify your changes:
30+
31+
- [ ] Unit tests pass (`pytest tests/unit/`)
32+
- [ ] Integration tests pass (`pytest tests/integration/`)
33+
- [ ] Manual testing completed
34+
- [ ] New tests added for new functionality
35+
36+
**Test Configuration**:
37+
- Python version:
38+
- Operating System:
39+
40+
## Checklist
41+
Please review and check all applicable items:
42+
43+
### Code Quality
44+
- [ ] My code follows the style guidelines of this project (PEP 8, Black formatting)
45+
- [ ] I have performed a self-review of my own code
46+
- [ ] I have commented my code, particularly in hard-to-understand areas
47+
- [ ] My changes generate no new warnings or errors
48+
- [ ] I have added type hints where applicable
49+
50+
### Documentation
51+
- [ ] I have made corresponding changes to the documentation
52+
- [ ] I have updated the README.md if needed
53+
- [ ] I have added/updated docstrings for new functions/classes
54+
- [ ] I have updated CLAUDE.md if this introduces new development practices
55+
56+
### Testing
57+
- [ ] I have added tests that prove my fix is effective or that my feature works
58+
- [ ] New and existing unit tests pass locally with my changes
59+
- [ ] I have added edge cases to my tests
60+
- [ ] Code coverage has not decreased
61+
62+
### Dependencies
63+
- [ ] I have updated requirements.txt if new dependencies were added
64+
- [ ] I have updated requirements-dev.txt if new dev dependencies were added
65+
- [ ] All dependencies are properly versioned
66+
67+
## Screenshots/Output (if applicable)
68+
Add screenshots or command output to help explain your changes.
69+
70+
## Additional Notes
71+
Any additional information that reviewers should know.
72+
73+
## Review Request
74+
Please tag specific people if you'd like their review:
75+
- @username for specific expertise
76+
77+
---
78+
**By submitting this PR, I confirm that my contribution is made under the terms of the project's license.**

0 commit comments

Comments
 (0)