pull_request_template.md•2.41 kB
# Pull Request
## Description
Brief description of the changes in this PR.
Fixes #(issue number)
## Type of Change
Please delete options that are not relevant:
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring
- [ ] Test improvement
## Changes Made
- [ ] List specific changes made
- [ ] Include technical details
- [ ] Mention any new dependencies
- [ ] Note configuration changes
## Testing
- [ ] Unit tests pass (`npm test`)
- [ ] Integration tests pass (`npm run test:integration`)
- [ ] Manual testing completed
- [ ] Cross-platform testing (if applicable)
### Test Instructions
Provide step-by-step instructions for testing this change:
1. Step one
2. Step two
3. Expected result
## Screenshots/Demos
If applicable, add screenshots or demo videos to help explain your changes.
## Documentation
- [ ] Code comments added/updated
- [ ] README.md updated (if needed)
- [ ] CHANGELOG.md updated (if applicable)
- [ ] API documentation updated (if needed)
## Checklist
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings or errors
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published
## Breaking Changes
If this PR introduces breaking changes, please describe:
- What breaks?
- What is the migration path?
- Are there any deprecation notices needed?
## Additional Notes
Add any additional notes, concerns, or questions for reviewers.
## Reviewer Guidelines
### For Maintainers
- [ ] Code quality and style consistency
- [ ] Test coverage is adequate
- [ ] Documentation is clear and complete
- [ ] Breaking changes are properly communicated
- [ ] Performance impact is acceptable
### Focus Areas
Please pay special attention to:
- [ ] Security implications
- [ ] Performance impact
- [ ] Backward compatibility
- [ ] Error handling
- [ ] Edge cases