|
| 1 | +# Pull Request |
| 2 | + |
| 3 | +## Description |
| 4 | +Brief description of the changes made in this PR. |
| 5 | + |
| 6 | +## Type of Change |
| 7 | +- [ ] Bug fix (non-breaking change which fixes an issue) |
| 8 | +- [ ] New feature (non-breaking change which adds functionality) |
| 9 | +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
| 10 | +- [ ] Documentation update |
| 11 | +- [ ] Performance improvement |
| 12 | +- [ ] Refactoring (no functional changes) |
| 13 | + |
| 14 | +## Related Issues |
| 15 | +Fixes #(issue number) |
| 16 | + |
| 17 | +## Changes Made |
| 18 | +- List the main changes |
| 19 | +- Include any new files added |
| 20 | +- Mention any dependencies added/removed |
| 21 | + |
| 22 | +## Testing Checklist |
| 23 | + |
| 24 | +### Local Testing |
| 25 | +- [ ] All existing tests pass locally (`python run_tests.py`) |
| 26 | +- [ ] New functionality is covered by tests |
| 27 | +- [ ] Code coverage is maintained or improved |
| 28 | +- [ ] Linting passes (Black, isort, flake8) |
| 29 | +- [ ] No security issues detected (bandit, safety) |
| 30 | + |
| 31 | +### Test Categories |
| 32 | +- [ ] Unit tests added/updated |
| 33 | +- [ ] Integration tests added/updated if needed |
| 34 | +- [ ] API validation tests added if new endpoints |
| 35 | +- [ ] Performance impact assessed |
| 36 | + |
| 37 | +### CI/CD |
| 38 | +- [ ] GitHub Actions workflow passes |
| 39 | +- [ ] No test failures in CI |
| 40 | +- [ ] Coverage reports are acceptable |
| 41 | +- [ ] Security scans pass |
| 42 | + |
| 43 | +## API Changes |
| 44 | +If this PR introduces API changes: |
| 45 | +- [ ] OpenAPI/Swagger documentation updated |
| 46 | +- [ ] Breaking changes are documented |
| 47 | +- [ ] Migration guide provided (if needed) |
| 48 | +- [ ] Backward compatibility maintained (or breaking change justified) |
| 49 | + |
| 50 | +## Database Changes |
| 51 | +If this PR includes database changes: |
| 52 | +- [ ] Migration scripts created |
| 53 | +- [ ] Migration tested locally |
| 54 | +- [ ] Data migration strategy documented |
| 55 | +- [ ] Rollback plan documented |
| 56 | + |
| 57 | +## Deployment Considerations |
| 58 | +- [ ] Environment variables updated (if needed) |
| 59 | +- [ ] Configuration changes documented |
| 60 | +- [ ] Docker configuration updated (if needed) |
| 61 | +- [ ] Dependencies updated in requirements.txt |
| 62 | + |
| 63 | +## Documentation |
| 64 | +- [ ] Code is self-documenting with clear variable and function names |
| 65 | +- [ ] Complex logic is commented |
| 66 | +- [ ] API documentation updated |
| 67 | +- [ ] README updated (if needed) |
| 68 | +- [ ] Changelog updated |
| 69 | + |
| 70 | +## Review Guidelines |
| 71 | +- [ ] Code follows project style guidelines |
| 72 | +- [ ] Functions are focused and do one thing well |
| 73 | +- [ ] Error handling is appropriate |
| 74 | +- [ ] Security best practices followed |
| 75 | +- [ ] Performance implications considered |
| 76 | + |
| 77 | +## Screenshots (if applicable) |
| 78 | +Add screenshots to help explain your changes. |
| 79 | + |
| 80 | +## Additional Notes |
| 81 | +Any additional information that reviewers should know. |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +### For Reviewers |
| 86 | +Please ensure: |
| 87 | +- [ ] All tests pass in CI |
| 88 | +- [ ] Code review completed |
| 89 | +- [ ] Security review completed (if applicable) |
| 90 | +- [ ] Performance review completed (if applicable) |
| 91 | +- [ ] Documentation review completed |
0 commit comments