PULL_REQUEST_TEMPLATE.md•2.35 kB
# Pull Request
## Description
Brief description of the changes made in this PR.
## Type of Change
Please delete options that are not relevant and check the appropriate box:
- [ ] 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
- [ ] Refactoring (no functional changes)
- [ ] Test improvements
- [ ] CI/CD changes
## Testing
Please describe the tests that you ran to verify your changes:
- [ ] Tests pass locally with `uv run pytest`
- [ ] Code follows the style guidelines (`uv run ruff check .`)
- [ ] Code is properly formatted (`uv run ruff format --check .`)
- [ ] Pre-commit hooks pass (`uv run pre-commit run --all-files`)
- [ ] New tests added for new functionality
- [ ] Documentation updated (if applicable)
## Test Configuration
* Python version(s):
* Operating System:
* Storage backend tested: [file/mongodb]
## Checklist
Please check all that apply:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own 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 in downstream modules
## Breaking Changes
If this is a breaking change, please describe the impact and migration path for existing users:
- [ ] This change is backward compatible
- [ ] This change requires users to update their code
- [ ] Migration guide provided in documentation
## Related Issues
Closes #(issue number)
Fixes #(issue number)
Relates to #(issue number)
## Screenshots (if applicable)
If this change affects the UI or has visual impact, please include screenshots.
## Additional Notes
Add any other notes about the PR here.
---
**For Maintainers:**
- [ ] Code review completed
- [ ] Tests pass on all platforms
- [ ] Documentation reviewed
- [ ] Changelog updated (if applicable)
- [ ] Version bump needed (if applicable)