| name | bug-fix-workflow |
| description | Fix bugs using the two-commit structure with failing test first. Use when fixing bugs, addressing issues, or correcting incorrect behavior. |
| user-invocable | true |
| argument-hint | [issue number or bug description] |
| allowed-tools | Bash(cargo test *), Bash(cargo clippy *), Bash(cargo fmt *), Bash(cargo check *), Bash(git add *), Bash(git commit *), Read, Edit, Write, Grep, Glob |
Bug Fix Workflow
Bug fixes in this project use a two-commit structure that proves the bug exists before fixing it.
The Two-Commit Structure
Commit 1: Reproduce the Bug
test: reproduce <issue description>
This commit adds a failing test that demonstrates the bug:
- The test should fail BEFORE the fix
- The test should pass AFTER the fix
- The test prevents future regressions
Commit 2: Fix the Bug
fix: <description of what was fixed>
This commit:
- Fixes the actual bug
- Updates the test if needed (e.g., expected values)
- May include additional related fixes
Why This Structure?
- Proves the bug exists before the fix
- Validates the fix actually resolves the issue
- Prevents regressions by leaving the test in place
- Makes review easier by separating reproduction from fix
Workflow Steps
1. Understand the Bug
- Read the issue/report carefully
- Identify the expected vs actual behavior
- Determine the root cause
2. Write a Failing Test
#[test]
fn issue_123_fragment_spread_on_wrong_type() {
let result = validate("...");
assert!(!result.diagnostics.is_empty());
}
3. Verify the Test Fails
cargo test issue_123
4. Commit the Failing Test
git add .
git commit -m "test: reproduce fragment spread type mismatch (issue #123)"
5. Implement the Fix
Make the minimal changes needed to fix the bug.
6. Verify the Test Passes
cargo test issue_123
cargo test
7. Commit the Fix
git add .
git commit -m "fix: validate fragment spread target type exists in schema
The fragment spread validator was not checking if the target type
existed in the schema before validating field selections."
Commit Message Guidelines
Test Commit
test: reproduce <brief description>
- Reference issue number if applicable
- Describe what the test checks
- Note expected vs actual behavior
Fix Commit
fix: <what was fixed>
<Why the bug occurred>
<What the fix does>
<Any side effects or related changes>
Common Mistakes to Avoid
- Don't combine test and fix in one commit
- Don't write a passing test first - the test must fail initially
- Don't skip the test for "obvious" fixes
- Don't forget to run all tests before the fix commit
Checklist
