simplify: Make templates more concise and user-friendly
This commit is contained in:
85
.github/pull_request_template.md
vendored
85
.github/pull_request_template.md
vendored
@@ -1,84 +1,13 @@
|
||||
## 📋 Description
|
||||
## What does this PR do?
|
||||
|
||||
<!-- Provide a brief description of your changes -->
|
||||
<!-- Brief description of your changes -->
|
||||
|
||||
## 🎯 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
|
||||
- [ ] 🎨 Code refactoring
|
||||
- [ ] ⚡ Performance improvement
|
||||
- [ ] 🧪 Test addition/modification
|
||||
- [ ] 🔧 Build/CI configuration change
|
||||
|
||||
## 🔗 Related Issues
|
||||
|
||||
<!-- Link any related issues using #issue_number -->
|
||||
## Related Issues
|
||||
|
||||
Fixes #
|
||||
Related to #
|
||||
|
||||
## ✅ Checklist
|
||||
## Checklist
|
||||
|
||||
<!-- Mark completed items with an "x" -->
|
||||
|
||||
- [ ] My code follows the style guidelines of this project (ran `ruff format` and `ruff check`)
|
||||
- [ ] 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 in downstream modules
|
||||
- [ ] I have run pre-commit hooks (`pre-commit run --all-files`)
|
||||
|
||||
## 🧪 Testing
|
||||
|
||||
<!-- Describe the tests you ran to verify your changes -->
|
||||
|
||||
### Test Configuration
|
||||
- **Python version**:
|
||||
- **Operating System**:
|
||||
|
||||
### Test Results
|
||||
<!-- Provide test output or describe results -->
|
||||
|
||||
```bash
|
||||
# Add test command outputs here
|
||||
```
|
||||
|
||||
## 📸 Screenshots (if applicable)
|
||||
|
||||
<!-- Add screenshots to help explain your changes -->
|
||||
|
||||
## 📝 Additional Notes
|
||||
|
||||
<!-- Add any additional notes, concerns, or discussion points -->
|
||||
|
||||
## 🚀 Performance Impact
|
||||
|
||||
<!-- If applicable, describe any performance impacts (positive or negative) -->
|
||||
|
||||
- [ ] No performance impact
|
||||
- [ ] Performance improvement (describe below)
|
||||
- [ ] Potential performance regression (explain mitigation)
|
||||
|
||||
<!-- Details: -->
|
||||
|
||||
## 🔄 Migration Guide (if breaking change)
|
||||
|
||||
<!-- If this PR contains breaking changes, provide a migration guide -->
|
||||
|
||||
### Before
|
||||
```python
|
||||
# Old usage example
|
||||
```
|
||||
|
||||
### After
|
||||
```python
|
||||
# New usage example
|
||||
```
|
||||
- [ ] Tests pass (`uv run pytest`)
|
||||
- [ ] Code formatted (`ruff format` and `ruff check`)
|
||||
- [ ] Pre-commit hooks pass (`pre-commit run --all-files`)
|
||||
|
||||
Reference in New Issue
Block a user