Bug Fix Pull Request Template

Bug Fix PR Template

Bug fix PRs require more context than typical feature PRs. Reviewers need to understand the original bug, its root cause, the fix approach, and how it was verified. This template captures all of that information.

Template Structure

## Bug Description
<!-- What was the bug? Include error messages, unexpected behavior, or screenshots. -->

## Root Cause
<!-- What was causing the bug? -->

## Fix Description
<!-- How does this PR fix the bug? -->

## Type of Change
- [x] Bug fix (non-breaking change which fixes an issue)

## Reproduction Steps
1. Go to '...'
2. Click on '...'
3. See error

## Checklist
- [ ] I have performed a self-review of my code
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective
- [ ] New and existing unit tests pass locally
- [ ] I have verified the bug is fixed
- [ ] I have added a regression test

## Testing
<!-- How did you verify the fix? What edge cases did you test? -->

## Related Issues
<!-- Fixes #(issue number) -->

Why Root Cause Matters

Including a Root Cause section forces the developer to articulate why the bug occurred, not just how to patch it. This helps reviewers assess whether the fix addresses the underlying problem or just masks the symptom.

Regression Tests

The checklist specifically asks for a regression test — a test that would have caught the original bug. This prevents the same bug from reappearing in future changes.

Reproduction Steps

Detailed reproduction steps help reviewers verify the fix independently and also serve as documentation. If the bug reappears later, the reproduction steps provide a starting point for investigation.