bug-fix-brief
SolidGenerates a structured Bug Fix Brief (BFB) to document issue corrections. Includes root cause analysis, repro steps, fix options, and fix checklist. Use when user asks to create a BFB, document a bug fix, or generate a bug correction document.
AI & Automation 278 stars
32 forks Updated 5 days ago MIT
Install
Quality Score: 91/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
Skill Content
# Bug Fix Brief (BFB)
## Overview
This skill generates a Bug Fix Brief (BFB): a structured document in `docs/bfb/` that uniformly captures every bug fix with root cause, repro steps, fix options, and checklist.
## When to Use
- User asks to create a BFB
- User wants to document a bug fix in a structured way
- After identifying the root cause of a bug and before implementing the fix
**Trigger:** "create BFB", "document bug", "bug fix brief", "document fix"
## Instructions
### Phase 1: Gather Information
Check existing numbering:
```bash
ls docs/bfb/ 2>/dev/null || echo "Directory does not exist"
```
Ask the user for:
- BFB number (or propose next sequential)
- Concise title (3-5 words, kebab-case)
- Issue link (e.g. #1287)
- Environment (Prod/Stg/Dev) + version
- Observed vs expected behavior
- File/function/line of the cause
### Phase 2: Generate Template
Complete the full BFB template:
```markdown
## BFB-XXX: [Title]
**Reference:** [Issue link]
**Environment:** [Env] `vX.Y.Z`
**Date:** YYYY-MM-DD
---
### 1. Bug
- **Observed:** [wrong behavior]
- **Expected:** [correct behavior]
### 2. Repro
```
1. ...
2. ...
→ [error/output]
```
### 3. Cause
`path/file.ext` — `function()` @ line N
[Why it happens, max 3 lines]
### 4. Decision
| Option | Fix | Choice |
|--------|-----|--------|
| A | [desc] | ✅/❌ |
| B | [desc] | ✅/❌ |
**Rationale:** [why]
### 5. Fix
- [ ] [change 1]
- [ ] [test]
- [ ] [verify repro]
### 6. Notes
[recurring patterns, links, warnings]
```
...
Details
- Author
- giuseppe-trisciuoglio
- Repository
- giuseppe-trisciuoglio/developer-kit
- Created
- 7 months ago
- Last Updated
- 5 days ago
- Language
- Python
- License
- MIT
Integrates with
Similar Skills
Semantically similar based on skill content — not just same category
AI & Automation Listed
bugfix
ADS
0 Updated 1 weeks ago
fmachucas AI & Automation Listed
fix-bug
This skill should be used when the user asks to "fix bug", "resolve issue", "fix error", "troubleshoot", "debug", or reports a specific bug or error that needs investigation and fixing.
20 Updated yesterday
Mr-DooSun AI & Automation Listed
bug-hunt
Investigate bugs and root causes.
389 Updated today
boshu2