105 lines
2.6 KiB
Markdown
105 lines
2.6 KiB
Markdown
## 📋 Pull Request Description
|
|
|
|
<!-- Provide a brief description of the changes in this PR -->
|
|
|
|
## 🔗 Related Issues
|
|
|
|
<!-- Link to any related issues -->
|
|
- Closes #(issue number)
|
|
- Related to #(issue number)
|
|
|
|
## 🎯 Type of Change
|
|
|
|
<!-- Mark the relevant option with an "x" -->
|
|
|
|
- [ ] 🐛 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
|
|
- [ ] 🧪 Test improvements
|
|
- [ ] 🔧 Refactoring (no functional changes)
|
|
- [ ] ⚡ Performance improvement
|
|
- [ ] 🔒 Security fix
|
|
|
|
## 🧪 Testing
|
|
|
|
<!-- Describe the tests you ran to verify your changes -->
|
|
|
|
- [ ] Unit tests pass
|
|
- [ ] Integration tests pass
|
|
- [ ] Manual testing completed
|
|
- [ ] Tested on multiple platforms (if applicable)
|
|
|
|
### Test Commands
|
|
|
|
```bash
|
|
# Add any specific test commands you ran
|
|
cargo test
|
|
cargo clippy
|
|
cargo fmt
|
|
```
|
|
|
|
## 📸 Screenshots/Examples
|
|
|
|
<!-- If applicable, add screenshots or examples of the changes -->
|
|
|
|
### Before
|
|
```bash
|
|
# Example of behavior before changes
|
|
```
|
|
|
|
### After
|
|
```bash
|
|
# Example of behavior after changes
|
|
```
|
|
|
|
## 🔍 Code Quality
|
|
|
|
<!-- Mark completed items with an "x" -->
|
|
|
|
- [ ] Code follows project style guidelines
|
|
- [ ] Self-review completed
|
|
- [ ] Code is properly commented
|
|
- [ ] No unnecessary debug code or comments
|
|
- [ ] Error handling is appropriate
|
|
- [ ] Performance implications considered
|
|
|
|
## 📚 Documentation
|
|
|
|
<!-- Mark completed items with an "x" -->
|
|
|
|
- [ ] README updated (if needed)
|
|
- [ ] Code comments added/updated
|
|
- [ ] API documentation updated (if applicable)
|
|
- [ ] Examples updated (if applicable)
|
|
|
|
## 🚀 Deployment Notes
|
|
|
|
<!-- Any special deployment considerations -->
|
|
|
|
- [ ] No breaking changes
|
|
- [ ] Backward compatibility maintained
|
|
- [ ] Migration guide needed (if breaking changes)
|
|
- [ ] Configuration changes documented
|
|
|
|
## ✅ Checklist
|
|
|
|
<!-- Mark completed items with an "x" -->
|
|
|
|
- [ ] My code follows the style guidelines of this project
|
|
- [ ] I have performed a self-review of my own 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
|
|
- [ ] 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
|
|
|
|
## 🔄 Additional Notes
|
|
|
|
<!-- Any additional information that reviewers should know -->
|
|
|
|
## 👥 Reviewers
|
|
|
|
<!-- Tag specific reviewers if needed -->
|
|
@username |