xixu-me
d300760799
Removed all references to `CHANGELOG.md` in documentation and templates, and deleted the `docs/changelog.md` file. This change reflects a shift away from maintaining a changelog in favor of other documentation practices.
181 lines
4.2 KiB
Markdown
181 lines
4.2 KiB
Markdown
---
|
|
name: Pull Request
|
|
about: Submit a pull request to improve tzst
|
|
title: ''
|
|
labels: ''
|
|
assignees: ''
|
|
---
|
|
|
|
## Summary
|
|
|
|
<!-- Provide a brief summary of your changes -->
|
|
|
|
## Type of Change
|
|
|
|
<!-- Mark with an "x" all that apply -->
|
|
|
|
- [ ] 🐛 Bug fix (non-breaking change that fixes an issue)
|
|
- [ ] ✨ New feature (non-breaking change that adds functionality)
|
|
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to change)
|
|
- [ ] 📚 Documentation update (changes to documentation only)
|
|
- [ ] 🧪 Test improvements (adding or updating tests)
|
|
- [ ] 🔧 Build/CI changes (changes to build process or CI configuration)
|
|
- [ ] ♻️ Refactoring (code changes that neither fix bugs nor add features)
|
|
- [ ] ⚡ Performance improvement
|
|
- [ ] 🔒 Security fix
|
|
|
|
## Related Issues
|
|
|
|
<!-- Link to related issues using keywords -->
|
|
<!-- Examples: -->
|
|
<!-- Fixes #123 -->
|
|
<!-- Closes #456 -->
|
|
<!-- Related to #789 -->
|
|
|
|
## Changes Made
|
|
|
|
<!-- Describe the changes you made in detail -->
|
|
|
|
### Core Changes
|
|
<!-- List main functionality changes -->
|
|
-
|
|
|
|
### API Changes
|
|
<!-- List any API changes (breaking or non-breaking) -->
|
|
-
|
|
|
|
### CLI Changes
|
|
<!-- List any command-line interface changes -->
|
|
-
|
|
|
|
## Testing
|
|
|
|
<!-- Describe the testing you performed -->
|
|
|
|
### Test Coverage
|
|
|
|
- [ ] Added tests for new functionality
|
|
- [ ] Updated existing tests as needed
|
|
- [ ] All tests pass locally (`python -m pytest`)
|
|
- [ ] Code coverage is maintained or improved
|
|
|
|
### Manual Testing
|
|
<!-- Describe manual testing performed -->
|
|
- [ ] Tested on Windows
|
|
- [ ] Tested on macOS
|
|
- [ ] Tested on Linux
|
|
- [ ] Tested with Python 3.12
|
|
- [ ] Tested with Python 3.13
|
|
|
|
### Test Scenarios
|
|
<!-- List specific scenarios you tested -->
|
|
-
|
|
-
|
|
-
|
|
|
|
## Code Quality
|
|
|
|
<!-- Confirm code quality checks -->
|
|
|
|
- [ ] Code follows project style guidelines (`ruff check .`)
|
|
- [ ] Code is properly formatted (`ruff format --check .`)
|
|
- [ ] Type hints are added for new public APIs
|
|
- [ ] Docstrings are added/updated for public methods
|
|
- [ ] No new security vulnerabilities introduced
|
|
|
|
## Documentation
|
|
|
|
<!-- Mark documentation changes -->
|
|
|
|
- [ ] README.md updated (if needed)
|
|
- [ ] Code comments added for complex logic
|
|
- [ ] Docstrings updated for modified functions/classes
|
|
|
|
## Backwards Compatibility
|
|
|
|
<!-- Address compatibility concerns -->
|
|
|
|
- [ ] Changes are backwards compatible
|
|
- [ ] Breaking changes are documented and justified
|
|
- [ ] Migration guide provided (if applicable)
|
|
|
|
## Performance Impact
|
|
|
|
<!-- Describe any performance implications -->
|
|
|
|
- [ ] No performance regression
|
|
- [ ] Performance improvement (describe below)
|
|
- [ ] Performance impact assessed and documented
|
|
|
|
<!-- If there are performance changes, describe them -->
|
|
|
|
## Security Considerations
|
|
|
|
<!-- Address security aspects -->
|
|
|
|
- [ ] No security implications
|
|
- [ ] Security review completed
|
|
- [ ] Input validation added/updated
|
|
- [ ] Secure defaults maintained
|
|
|
|
## Platform Compatibility
|
|
|
|
<!-- Confirm platform testing -->
|
|
|
|
- [ ] Windows compatibility verified
|
|
- [ ] macOS compatibility verified
|
|
- [ ] Linux compatibility verified
|
|
- [ ] Cross-platform file path handling tested
|
|
|
|
## Dependencies
|
|
|
|
<!-- Note any dependency changes -->
|
|
|
|
- [ ] No new dependencies added
|
|
- [ ] New dependencies are justified and minimal
|
|
- [ ] Dependency versions are appropriately constrained
|
|
- [ ] Optional dependencies are properly marked
|
|
|
|
## Deployment
|
|
|
|
<!-- For maintainers - deployment considerations -->
|
|
|
|
- [ ] Version number updated (if applicable)
|
|
- [ ] Release notes prepared (if applicable)
|
|
- [ ] Migration steps documented (if applicable)
|
|
|
|
## Checklist
|
|
|
|
<!-- Final review checklist -->
|
|
|
|
- [ ] PR title follows conventional commit format
|
|
- [ ] All CI checks are passing
|
|
- [ ] Code has been self-reviewed
|
|
- [ ] Changes have been tested thoroughly
|
|
- [ ] Documentation is complete and accurate
|
|
- [ ] Ready for code review
|
|
|
|
## Additional Notes
|
|
|
|
<!-- Add any additional context, screenshots, or notes for reviewers -->
|
|
|
|
## Reviewer Notes
|
|
|
|
<!-- For reviewers - any specific areas to focus on -->
|
|
|
|
### Review Focus Areas
|
|
<!-- What should reviewers pay special attention to? -->
|
|
-
|
|
-
|
|
-
|
|
|
|
### Questions for Reviewers
|
|
<!-- Any specific questions for the review team -->
|
|
-
|
|
-
|
|
|
|
---
|
|
|
|
<!-- Thank you for contributing to tzst! -->
|
|
<!-- Please ensure all items above are completed before requesting review -->
|