Skip to content
76 changes: 76 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
## Description

Brief description of what this PR does and why.

Closes #(issue number)

## 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 change)
- [ ] Documentation update

## Changes Made

- Change 1
- Change 2
- Change 3

## Testing

### How has this been tested?

Describe the tests you ran and how to reproduce them.

- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Manual testing performed

### Test Coverage

Describe what scenarios have been tested:
- Happy path:
- Edge cases:
- Error handling:

## Code Quality Checklist

- [ ] My code follows the style guidelines of this project (`cargo fmt`)
- [ ] 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 (`cargo clippy -- -D 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
- [ ] The CI checks pass (format, clippy, tests)

## Breaking Changes

- [ ] This PR introduces breaking changes

If checked, describe the breaking changes and migration path:

## Documentation

- [ ] README.md updated
- [ ] DEVELOPER_GUIDE.md updated (if applicable)
- [ ] API_REFERENCE.md updated (if applicable)
- [ ] No documentation changes needed

## Screenshots (if applicable)

Add screenshots or GIFs for UI changes.

## Additional Context

Add any other context about the PR here.

---

**Note**: Make sure all tests pass locally before submitting:
```bash
cargo test
cargo fmt --all
cargo clippy -- -D warnings
```
Loading