This directory contains workflows for debugging and fixing bugs.
| File | Purpose | When to Use |
|---|---|---|
01-bug-description.md |
Structure and document bug reports | When receiving or creating bug reports |
02-bug-fix-workflow.md |
Systematically identify and fix bugs | When debugging issues or fixing bugs |
┌─────────────────────┐ ┌──────────────────────────┐
│ 01-bug-description │ ───▶ │ 02-bug-fix-workflow.md │
│ (Document the bug) │ │ (Fix the bug) │
└─────────────────────┘ └──────────────────────────┘
Received or discovered a bug that needs documentation?
- Yes → Use
01-bug-description.md
Need to systematically fix a bug?
- Yes → Use
02-bug-fix-workflow.md
A good bug report includes:
- Observed behavior - What actually happened
- Expected behavior - What should have happened
- Reproduction steps - How to trigger the bug
- Environment - Context where bug occurs
- Impact assessment - Severity and priority
The bug fix workflow uses a structured approach:
- Reproduce the issue consistently
- Isolate the root cause
- Implement the minimal fix
- Verify the fix works
- Check for regressions
- Document the fix
- Code Build - Implement the fix
- Confirm Execution - Verify the fix
- Code Review - Review the fix
- Sync Documentation - Update docs with bug info