| name | bug-fixing |
| description | TDD-based workflow for fixing bugs and defects. Use when investigating, reproducing, and resolving reported issues or unexpected behavior. |
| metadata | {"author":"vsirotin","version":"1.0"} |
Bug-Fixing Workflow (TDD)
Note: This skill is based on common-development. Read the origin document first for complete development rules.
Workflow
When fixing a bug, always follow this order:
-
Write a failing unit test — Create a test that fails because of the bug.
-
Confirm the test fails — Run the test to verify it fails, ensuring the test correctly captures the defect.
-
Fix the code — Implement the minimal fix to resolve the bug.
-
Confirm the test passes — Run the test to verify it passes. Small adjustments to the implementation or test may be needed, but reducing the number of tests or skipping them should be done only after careful consideration of the consequences.
-
Report the result — Document the fix.
Additional Rules
These rules from common-development also apply:
- Stop if the bug fix requires more than 20 iterations (see rule 12)
- Follow consistent coding style (see rule 4)
- Include logging in important functions (see rule 3)
- Ensure the bug fix doesn't break existing tests — all unit tests in the project must pass (see rule 9)
