tzst/.github/PULL_REQUEST_TEMPLATE.md

name, about, title, labels, assignees

name	about	title	labels	assignees
Pull Request	Submit a pull request to improve tzst

Summary

Type of Change

• 🐛 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

Changes Made

Core Changes

API Changes

CLI Changes

Testing

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

• Tested on Windows
• Tested on macOS
• Tested on Linux
• Tested with Python 3.12
• Tested with Python 3.13

Test Scenarios

Code Quality

• 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

• README.md updated (if needed)
• Code comments added for complex logic
• Docstrings updated for modified functions/classes

Backwards Compatibility

• Changes are backwards compatible
• Breaking changes are documented and justified
• Migration guide provided (if applicable)

Performance Impact

• No performance regression
• Performance improvement (describe below)
• Performance impact assessed and documented

Security Considerations

• No security implications
• Security review completed
• Input validation added/updated
• Secure defaults maintained

Platform Compatibility

• Windows compatibility verified
• macOS compatibility verified
• Linux compatibility verified
• Cross-platform file path handling tested

Dependencies

• No new dependencies added
• New dependencies are justified and minimal
• Dependency versions are appropriately constrained
• Optional dependencies are properly marked

Deployment

• Version number updated (if applicable)
• Release notes prepared (if applicable)
• Migration steps documented (if applicable)

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

Reviewer Notes

Review Focus Areas

Questions for Reviewers

---