Bug Fix Workflow
Fix bugs systematically while ensuring proper test coverage and documentation.
Workflow
1. Bug Name
Determine a concise, descriptive bug name (kebab-case) for the report directory. Derive from the issue description or ask the user if unclear.
2. Systematic Investigation
Invoke the systematic-debugger skill to perform structured root cause analysis:
- •Phase 1: Initial Overview (problem statement)
- •Phase 2: Systematic Inspection (identify defects)
- •Phase 3: Root Cause Analysis (Five Whys)
- •Phase 4: Solution & Verification (proposed fixes)
Capture findings for the bugfix report.
3. Create Regression Test
Before implementing the fix:
- •Write a failing test that reproduces the bug
- •Run the test to confirm it fails as expected
- •This test prevents future regressions
The test should:
- •Be minimal and focused on the specific bug
- •Include a descriptive name referencing the bug
- •Document the expected vs actual behaviour in comments
4. Implement Fix
Apply the fix identified during investigation:
- •Make minimal, targeted changes
- •Run the regression test to confirm it passes
- •Run full test suite to ensure no breakage
- •Run linters/validators as per project conventions
5. Update Documentation
Review and update any affected documentation:
- •Code comments if behaviour changed
- •README or docs if user-facing
- •API docs if interface changed
6. Generate Bugfix Report
Create specs/bugfixes/<bug-name>/report.md using the template in references/report-template.md.
Output
Upon completion:
- •Bug is fixed and verified
- •Regression test exists and passes
- •Full test suite passes
- •Report exists at
specs/bugfixes/<bug-name>/report.md - •Code is ready for commit (do not commit unless asked)