9ea40bec61
Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
3.3 KiB
3.3 KiB
Pull Request
Description
Type of Change
- 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
- Security fix
- Dependency update
Related Issues
Fixes # Relates to #
Changes Made
Testing
Test Environment
- OS:
- Python Version:
- Database:
- Browser (if applicable):
Tests Performed
- Unit tests pass
- Integration tests pass
- Manual testing completed
- Browser compatibility tested (if UI changes)
Test Coverage
- Added new tests for new functionality
- Updated existing tests
- No tests needed (documentation/config only)
Security Checklist
- No sensitive data (API keys, passwords, tokens) included in code
- All user inputs are validated and sanitized
- No SQL injection vulnerabilities
- No XSS vulnerabilities
- Dependencies checked for known vulnerabilities
- Security implications documented (if applicable)
Documentation
- Code comments added/updated
- README.md updated (if needed)
- Documentation updated (if needed)
- CHANGELOG.md updated
- API documentation updated (if applicable)
Screenshots (if applicable)
Before
After
Deployment Notes
- Database migrations required
- Environment variables added/changed
- Configuration changes needed
- Dependencies updated (requirements.txt)
- No deployment steps required
Migration Steps
Performance Impact
- No performance impact
- Performance improved
- Performance impact (explain below)
Breaking Changes
Checklist
- My code follows the project's coding standards (PEP 8)
- 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
- 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
- I have checked my code for security vulnerabilities
Additional Notes
For Reviewers
Review Focus Areas
- Security implications
- Performance impact
- Code quality and maintainability
- Test coverage
- Documentation completeness