|
| 1 | +## Summary |
| 2 | + |
| 3 | +<!-- Briefly describe what this PR does and why it's needed --> |
| 4 | + |
| 5 | + |
| 6 | +## Type of Change |
| 7 | + |
| 8 | +- [ ] Bug fix (non-breaking change which fixes an issue) |
| 9 | +- [ ] New feature (non-breaking change which adds functionality) |
| 10 | +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
| 11 | +- [ ] Refactoring (code improvement without changing functionality) |
| 12 | +- [ ] Documentation update |
| 13 | +- [ ] Performance improvement |
| 14 | +- [ ] CI/CD or tooling change |
| 15 | +- [ ] Dependency update |
| 16 | + |
| 17 | +## Related Issues |
| 18 | + |
| 19 | +<!-- Link to related issues (e.g., Fixes #123, Relates to #456) --> |
| 20 | + |
| 21 | +Fixes # |
| 22 | +Relates to # |
| 23 | + |
| 24 | +## Changes Made |
| 25 | + |
| 26 | +<!-- List the main changes in this PR --> |
| 27 | + |
| 28 | +- |
| 29 | +- |
| 30 | +- |
| 31 | + |
| 32 | +## Testing |
| 33 | + |
| 34 | +<!-- Describe how you tested these changes --> |
| 35 | + |
| 36 | +**Test Commands Run:** |
| 37 | +- [ ] `uv run nox -s test` (all tests passed, coverage ≥ 75%) |
| 38 | +- [ ] `uv run nox -s lint -- --pyright --ruff` (no errors) |
| 39 | +- [ ] `uv run nox -s fmt` (formatting applied) |
| 40 | +- [ ] `uv run pre-commit run --all-files` (all hooks passed) |
| 41 | + |
| 42 | +**Testing Notes:** |
| 43 | +<!-- Add any relevant testing details, edge cases covered, or manual testing steps --> |
| 44 | + |
| 45 | + |
| 46 | +## Pre-Submission Checklist |
| 47 | + |
| 48 | +<!-- Verify ALL items before requesting review --> |
| 49 | + |
| 50 | +### Code Quality & Tests |
| 51 | +- [ ] All functions/methods have type hints |
| 52 | +- [ ] Code has docstrings for public APIs |
| 53 | +- [ ] New test files follow `test__*.py` naming convention |
| 54 | +- [ ] Tests are meaningful and cover edge cases |
| 55 | + |
| 56 | +### Dependencies & Documentation |
| 57 | +- [ ] Used `uv add` for dependencies (not manual `pyproject.toml` edits) |
| 58 | +- [ ] `uv.lock` is updated and committed |
| 59 | +- [ ] Documentation updated (`README.md`, `CLAUDE.md`, or `docs/` if applicable) |
| 60 | +- [ ] Environment variables documented (if new ones added to `Settings`) |
| 61 | + |
| 62 | +### Configuration Changes |
| 63 | +- [ ] No configuration changes |
| 64 | +- OR if config changed: |
| 65 | + - [ ] `.env` updated with new variables and defaults |
| 66 | + - [ ] `Settings` class updated |
| 67 | + - [ ] No secrets committed (use `.env.local` for sensitive values) |
| 68 | + |
| 69 | +## Breaking Changes |
| 70 | + |
| 71 | +- [ ] This PR does NOT include breaking changes |
| 72 | + |
| 73 | +<!-- If there ARE breaking changes, describe them below --> |
| 74 | + |
| 75 | +**Breaking Changes Details:** |
| 76 | +<!-- Describe what breaks, migration path, and affected users/systems --> |
| 77 | + |
| 78 | + |
| 79 | +## Additional Notes |
| 80 | + |
| 81 | +<!-- Add screenshots, performance notes, deployment instructions, or reviewer guidance if needed --> |
0 commit comments