|
| 1 | +## Description |
| 2 | + |
| 3 | +Brief description of the changes made in this PR. |
| 4 | + |
| 5 | +## Type of Change |
| 6 | + |
| 7 | +<!-- What type of change does this PR introduce? --> |
| 8 | +<!-- Please check the one that applies to this PR using "x". --> |
| 9 | + |
| 10 | +- [ ] 🐛 **Bug fix** (non-breaking change which fixes an issue) |
| 11 | +- [ ] ✨ **New feature** (non-breaking change which adds functionality) |
| 12 | +- [ ] 💥 **Breaking change** (fix or feature that would cause existing functionality to not work as expected) |
| 13 | +- [ ] 📚 **Documentation** (updates to documentation) |
| 14 | +- [ ] 🎨 **Style** (code style changes, formatting, etc.) |
| 15 | +- [ ] ♻️ **Refactor** (code refactoring, no functional changes) |
| 16 | +- [ ] ⚡ **Performance** (performance improvements) |
| 17 | +- [ ] ✅ **Test** (adding or updating tests) |
| 18 | +- [ ] 🔧 **Build/CI** (changes to build process or CI configuration) |
| 19 | +- [ ] 🔒 **Security** (security-related changes) |
| 20 | +- [ ] 🚀 **Release** (version bump, release notes, etc.) |
| 21 | + |
| 22 | +## Changes Made |
| 23 | + |
| 24 | +<!-- List the specific changes made in this PR --> |
| 25 | + |
| 26 | +- Change 1 |
| 27 | +- Change 2 |
| 28 | +- Change 3 |
| 29 | + |
| 30 | +## Testing |
| 31 | + |
| 32 | +<!-- Describe the testing you performed --> |
| 33 | + |
| 34 | +### Testing Completed |
| 35 | + |
| 36 | +- [ ] Unit tests pass (`uv run python -m pytest tests/`) |
| 37 | +- [ ] Integration tests pass |
| 38 | +- [ ] Linting passes (`uv run ruff check flytrap/`) |
| 39 | +- [ ] Type checking passes (`uv run python -m mypy flytrap/ --ignore-missing-imports`) |
| 40 | +- [ ] Manual testing completed |
| 41 | +- [ ] Documentation updated |
| 42 | + |
| 43 | +### Test Coverage |
| 44 | + |
| 45 | +<!-- If applicable, describe test coverage changes --> |
| 46 | +- [ ] New tests added for new functionality |
| 47 | +- [ ] Existing test coverage maintained or improved |
| 48 | +- [ ] Test coverage report attached |
| 49 | + |
| 50 | +## Screenshots (if applicable) |
| 51 | + |
| 52 | +<!-- Add screenshots for UI changes, new features, or before/after comparisons --> |
| 53 | + |
| 54 | +## Breaking Changes |
| 55 | + |
| 56 | +<!-- If this PR introduces breaking changes, describe them here --> |
| 57 | + |
| 58 | +**Breaking Changes:** |
| 59 | +- List any breaking changes here |
| 60 | +- Include migration instructions if needed |
| 61 | + |
| 62 | +## Related Issues |
| 63 | + |
| 64 | +<!-- Link to related issues this PR addresses --> |
| 65 | + |
| 66 | +Closes #<!-- issue number --> |
| 67 | +Related to #<!-- issue number --> |
| 68 | + |
| 69 | +## Additional Notes |
| 70 | + |
| 71 | +<!-- Any additional information, context, or considerations --> |
| 72 | + |
| 73 | +## Checklist |
| 74 | + |
| 75 | +<!-- Please check all that apply --> |
| 76 | + |
| 77 | +- [ ] My code follows the project's style guidelines |
| 78 | +- [ ] I have performed a self-review of my own code |
| 79 | +- [ ] I have commented my code, particularly in hard-to-understand areas |
| 80 | +- [ ] I have made corresponding changes to the documentation |
| 81 | +- [ ] My changes generate no new warnings or errors |
| 82 | +- [ ] I have added tests that prove my fix is effective or that my feature works |
| 83 | +- [ ] New and existing unit tests pass locally with my changes |
| 84 | +- [ ] Any dependent changes have been merged and published in downstream modules |
| 85 | + |
| 86 | +## Reviewer Notes |
| 87 | + |
| 88 | +<!-- Notes for reviewers, if any --> |
| 89 | + |
| 90 | +## Deployment Notes |
| 91 | + |
| 92 | +<!-- Notes about deployment, if any special considerations are needed --> |
| 93 | + |
| 94 | +--- |
| 95 | + |
| 96 | +Thank you for contributing to Flytrap! 🎉 |
0 commit comments