By name: debugging description: Systematically diagnose and fix bugs.
Debugging Skill
When a test fails or an error occurs, follow this systematic debugging process:
- Reproduce – Run the failing scenario to reproduce the issue. Capture the exact inputs, environment variables and configuration used. Note the observed behaviour.
- Inspect – Read the error message, logs and stack trace to identify where the failure occurs. Examine recent changes and confirm the expected behaviour from the specification.
- Hypothesize – Form hypotheses about potential causes. Consider data flows, boundary conditions, concurrency issues, configuration problems and integration points.
- Isolate – Narrow down the cause by simplifying the input, adding logging or print statements, or using a debugger. Confirm or eliminate each hypothesis.
- Fix – Apply the minimal change necessary to resolve the issue. Ensure the fix aligns with the design and does not introduce new architectural violations.
- Verify – Re-run the relevant tests and scenarios to ensure the issue is fixed and no other behaviour is broken. Consider adding a regression test if one does not already exist.
- Document – Record the root cause, the steps taken to diagnose it, and the resolution. Update the specification or plan if the bug was due to ambiguous or missing requirements.
Repeat this process until all failures are resolved. Avoid random code changes; use evidence to drive your debugging.