* fix: overhaul Claude Code plugin for correctness and spec compliance - Fix critical bugs: coder-agent name (CoderAgent→coder-agent), manifest path in session-start.sh, /oac:setup ghost command replaced with /install-context - Fix hooks.json: add timeout/async, add description, restore matcher - Fix session-start.sh: dual-format output (Claude Code + Cursor/OpenCode), remove invalid JSON escapes for $ and backtick - Fix agent spec compliance: disallowedTools on read-only agents, WebFetch on external-scout, haiku model on context-scout, example blocks on 3 agents - Fix skill descriptions: triggering conditions only (no workflow summaries) per superpowers empirical testing — prevents Claude shortcutting skill content - Add Red Flags + Rationalization tables to 4 discipline skills - Add install-context skill + command replacing oac-setup/oac-plan/oac-add-context - Add cleanup-tmp.sh (was missing, broke /oac:cleanup) - Add TypeScript installer (install-context.ts/js) with profile-based download - Update plugin.json: keywords, homepage for marketplace discoverability - Update README: correct skill count, fix structure diagram, remove stale refs - Remove obsolete files: FIRST-TIME-SETUP.md, INSTALL.md, QUICK-START.md, download-context.sh, verify-context.sh, load-config.sh, context-manager skill, oac-setup/oac-plan/oac-add-context commands * add TypeScript and OpenCode context standards files Adds three new context files covering universal TypeScript patterns, OpenCode-specific patterns (fn() wrapper, namespaces, Instance.state()), and context-system-specific TypeScript coding standards. * fix(plugin): fix hooks and add missing skills for reliable skill invocation - Rewrite using-oac skill with always-on skill-check rule (was conditional on dev task detection) - Update session-start.sh to dynamically inject full skill catalogue at session start - Add brainstorming skill: intercepts creative/build work before any implementation - Add systematic-debugging skill: 4-phase root cause process before any fix - Add verification-before-completion skill: evidence-before-claims gate - Add /brainstorm and /debug slash commands as pure skill shortcuts - Fix oac-help to use disable-model-invocation:true (pure shortcut, not self-rendering) - Fix oac-status to be simpler bash-based status check
160 lines
5.4 KiB
Markdown
160 lines
5.4 KiB
Markdown
---
|
|
name: systematic-debugging
|
|
description: Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes
|
|
---
|
|
|
|
# Systematic Debugging
|
|
|
|
## Overview
|
|
|
|
Random fixes waste time and create new bugs. Quick patches mask underlying issues.
|
|
|
|
**Core principle:** ALWAYS find root cause before attempting fixes. Symptom fixes are failure.
|
|
|
|
**Violating the letter of this process is violating the spirit of debugging.**
|
|
|
|
## The Iron Law
|
|
|
|
```
|
|
NO FIXES WITHOUT ROOT CAUSE INVESTIGATION FIRST
|
|
```
|
|
|
|
If you haven't completed Phase 1, you cannot propose fixes.
|
|
|
|
## When to Use
|
|
|
|
Use for ANY technical issue:
|
|
- Test failures
|
|
- Bugs in production
|
|
- Unexpected behavior
|
|
- Performance problems
|
|
- Build failures
|
|
- Integration issues
|
|
|
|
**Use this ESPECIALLY when:**
|
|
- Under time pressure (emergencies make guessing tempting)
|
|
- "Just one quick fix" seems obvious
|
|
- You've already tried multiple fixes
|
|
- Previous fix didn't work
|
|
- You don't fully understand the issue
|
|
|
|
**Don't skip when:**
|
|
- Issue seems simple (simple bugs have root causes too)
|
|
- You're in a hurry (rushing guarantees rework)
|
|
|
|
## The Four Phases
|
|
|
|
You MUST complete each phase before proceeding to the next.
|
|
|
|
### Phase 1: Root Cause Investigation
|
|
|
|
**BEFORE attempting ANY fix:**
|
|
|
|
1. **Read Error Messages Carefully**
|
|
- Don't skip past errors or warnings
|
|
- They often contain the exact solution
|
|
- Read stack traces completely
|
|
- Note line numbers, file paths, error codes
|
|
|
|
2. **Reproduce Consistently**
|
|
- Can you trigger it reliably?
|
|
- What are the exact steps?
|
|
- Does it happen every time?
|
|
- If not reproducible → gather more data, don't guess
|
|
|
|
3. **Check Recent Changes**
|
|
- What changed that could cause this?
|
|
- Git diff, recent commits
|
|
- New dependencies, config changes
|
|
- Environmental differences
|
|
|
|
4. **Gather Evidence in Multi-Component Systems**
|
|
|
|
**WHEN system has multiple components:**
|
|
|
|
**BEFORE proposing fixes, add diagnostic instrumentation:**
|
|
```
|
|
For EACH component boundary:
|
|
- Log what data enters component
|
|
- Log what data exits component
|
|
- Verify environment/config propagation
|
|
- Check state at each layer
|
|
|
|
Run once to gather evidence showing WHERE it breaks
|
|
THEN analyze evidence to identify failing component
|
|
THEN investigate that specific component
|
|
```
|
|
|
|
5. **Trace Data Flow**
|
|
- Where does bad value originate?
|
|
- What called this with bad value?
|
|
- Keep tracing up until you find the source
|
|
- Fix at source, not at symptom
|
|
|
|
### Phase 2: Pattern Analysis
|
|
|
|
**Find the pattern before fixing:**
|
|
|
|
1. **Find Working Examples** — Locate similar working code in same codebase
|
|
2. **Compare Against References** — Read reference implementation COMPLETELY
|
|
3. **Identify Differences** — List every difference, however small
|
|
4. **Understand Dependencies** — What other components does this need?
|
|
|
|
### Phase 3: Hypothesis and Testing
|
|
|
|
**Scientific method:**
|
|
|
|
1. **Form Single Hypothesis** — "I think X is the root cause because Y"
|
|
2. **Test Minimally** — Make the SMALLEST possible change to test hypothesis
|
|
3. **Verify Before Continuing** — Did it work? Yes → Phase 4. No → form NEW hypothesis
|
|
4. **When You Don't Know** — Say "I don't understand X". Don't pretend to know.
|
|
|
|
### Phase 4: Implementation
|
|
|
|
**Fix the root cause, not the symptom:**
|
|
|
|
1. **Create Failing Test Case** — Simplest possible reproduction. MUST have before fixing.
|
|
2. **Implement Single Fix** — Address the root cause. ONE change at a time.
|
|
3. **Verify Fix** — Test passes? No other tests broken? Issue actually resolved?
|
|
4. **If Fix Doesn't Work** — STOP. Count fixes tried. If ≥ 3: question the architecture.
|
|
|
|
5. **If 3+ Fixes Failed: Question Architecture**
|
|
- Is this pattern fundamentally sound?
|
|
- Should we refactor architecture vs. continue fixing symptoms?
|
|
- Discuss with user before attempting more fixes
|
|
|
|
## Red Flags — STOP and Follow Process
|
|
|
|
If you catch yourself thinking:
|
|
- "Quick fix for now, investigate later"
|
|
- "Just try changing X and see if it works"
|
|
- "Add multiple changes, run tests"
|
|
- "It's probably X, let me fix that"
|
|
- "I don't fully understand but this might work"
|
|
- "One more fix attempt" (when already tried 2+)
|
|
|
|
**ALL of these mean: STOP. Return to Phase 1.**
|
|
|
|
## Common Rationalizations
|
|
|
|
| Excuse | Reality |
|
|
|--------|---------|
|
|
| "Issue is simple, don't need process" | Simple issues have root causes too. |
|
|
| "Emergency, no time for process" | Systematic debugging is FASTER than guess-and-check. |
|
|
| "Just try this first, then investigate" | First fix sets the pattern. Do it right from the start. |
|
|
| "Multiple fixes at once saves time" | Can't isolate what worked. Causes new bugs. |
|
|
| "I see the problem, let me fix it" | Seeing symptoms ≠ understanding root cause. |
|
|
| "One more fix attempt" (after 2+ failures) | 3+ failures = architectural problem. |
|
|
|
|
## Quick Reference
|
|
|
|
| Phase | Key Activities | Success Criteria |
|
|
|-------|---------------|------------------|
|
|
| **1. Root Cause** | Read errors, reproduce, check changes, gather evidence | Understand WHAT and WHY |
|
|
| **2. Pattern** | Find working examples, compare | Identify differences |
|
|
| **3. Hypothesis** | Form theory, test minimally | Confirmed or new hypothesis |
|
|
| **4. Implementation** | Create test, fix, verify | Bug resolved, tests pass |
|
|
|
|
**Related skills:**
|
|
- `oac:verification-before-completion` — Verify fix worked before claiming success
|
|
- `oac:test-generation` — For creating failing test cases (Phase 4, Step 1)
|