agentleFS
ThakurvaibhavThakurvaibhav/platform-agent-harness/skills/systematic-debugging/SKILL.md

systematic-debugging

Skill2 starsChanged 6 days agoApache-2.0View on GitHub

Four-phase root-cause protocol for a bug that has resisted the obvious fix. Use when stuck on a tricky bug, when retries have not converged, when a failure is intermittent, or when the user asks to debug methodically. Enforces evidence before hypothesis, one isolated hypothesis tested at a time, and a defense-in-depth fix rather than a patch at the first place that reproduces. Do NOT use when the cause is already known, or for Kubernetes workload triage (see k8s-debug).

190 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use chinese-code-review, chinese-commit-conventions and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • Leodorareluctant259Skill

    chinese-code-review

    中文代码审查规范——在保持专业严谨的同时,用符合国内团队文化的方式给出有效反馈

    Also in 8 projects that use this

  • Leodorareluctant259Skill

    chinese-commit-conventions

    中文 Git 提交规范 — 适配国内团队的 commit message 规范和 changelog 自动化

    Also in 8 projects that use this

  • obraSkill

    diagnosing-superpowers

    Use when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness.

    Also in 20 projects that use this

  • mjunaidcaSkill

    building-chatgpt-apps

    Guides creation of ChatGPT Apps with interactive widgets using OpenAI Apps SDK and MCP servers. Use when building ChatGPT custom apps with visual UI components, embedded widgets, or rich interactive experiences. Covers widget architecture, MCP server setup with FastMCP, response metadata, and Developer Mode configuration. NOT when building standard MCP servers without widgets (use building-mcp-servers skill instead).

    Also in 4 projects that use this

  • mjunaidcaSkill

    building-chat-interfaces

    Build AI chat interfaces with custom backends, authentication, and context injection. Use when integrating chat UI with AI agents, adding auth to chat, injecting user/page context, or implementing httpOnly cookie proxies. Covers ChatKitServer, useChatKit, and MCP auth patterns. NOT when building simple chatbots without persistence or custom agent integration.

    Also in 4 projects that use this

  • +2 more from Leodorareluctant259
  • +5 more from mjunaidca

The file

We split this skill into the rules it gives an agent

6 rules. 0 are common, 6 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 177 edited versions we read keep these.

  • 6

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Import errors with clear messages

    line 27
  2. Distinctive:

    Before forming any hypothesis, collect ALL available evidence.

    line 36
  3. Distinctive:

    If all 3 point to the same area, think broader: data issue?

    line 71
  4. Distinctive:

    If rejected, move to next

    line 81
  5. Distinctive:

    Every debugging session produces this summary:

    line 120
  6. Distinctive:

    After completing the report, persist the learning:

    line 147

“Common” is measured: kept by at least 6 in 10 of the 177 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Skill: Systematic Debugging

4-phase root cause investigation protocol. Prevents blind retry loops by enforcing evidence gathering, hypothesis formation, isolated testing, and defense-in-depth fixes.


When to use

  • Any error where the first fix attempt failed
  • Build/test failures that aren't obvious syntax or import errors
  • Gate failures after first retry
  • Any time you're about to retry the same thing hoping for a different result

When NOT to use

  • Obvious syntax errors (missing comma, typo)
  • Import errors with clear messages
  • Type errors with explicit expected/actual

The 4 phases

Phase 1: Gather evidence (DO NOT SKIP)

Before forming any hypothesis, collect ALL available evidence.

EVIDENCE CHECKLIST:
[ ] Exact error message (full text, not summary)
[ ] Full stack trace (if available)
[ ] Which command/test/gate produced the error
[ ] What changed since the last working state (git diff)
[ ] Environment state (versions, config)
[ ] Reproduction steps (reliable or intermittent?)
[ ] Related log output (not just the error line)
[ ] Recent changes to files in the error's dependency chain

Rule: Produce at least 3 pieces of evidence before proceeding. If you have fewer than 3, you haven't looked hard enough.


Phase 2: Form hypotheses (exactly 3, ranked)

From the evidence, generate 3 hypotheses. Not 1 (tunnel vision). Not 10 (unfocused).

HYPOTHESIS TABLE:
| # | Hypothesis | Evidence For | Evidence Against | Likelihood | How to Test |
|---|-----------|-------------|-----------------|------------|-------------|
| H1 | [Most likely] | | | High | |
| H2 | [Second likely] | | | Medium | |
| H3 | [Less likely but possible] | | | Low | |

Quality rules:

  • Each hypothesis must explain ALL symptoms, not just some
  • Each must have a testable prediction
  • "The code is wrong" is not a hypothesis -- be specific
  • If all 3 point to the same area, think broader: data issue? timing? config? dependency?

Phase 3: Test hypotheses (in order, stop when confirmed)

For each hypothesis:

  1. Define the test that would confirm or reject it
  2. Execute the test (minimal, isolated -- don't change production code yet)
  3. Record CONFIRMED or REJECTED with evidence
  4. If rejected, move to next

Techniques:

TechniqueWhenHow
Minimal reproductionComplex failuresSmallest case that still fails
Bisection"It worked before"git bisect or manual binary search
Component isolationMulti-service errorsTest each component independently
Input variationData-dependentTry different inputs to isolate trigger
Log injectionBlack-box failuresAdd temporary logging at each step

Phase 4: Fix and verify (defense in depth)

Once root cause is confirmed:

  1. Fix the root cause -- not the symptom
  2. Add a regression test -- fails without fix, passes with fix
  3. Check for similar patterns -- does this bug exist in similar code elsewhere?
  4. Verify the fix -- run the originally failing command
  5. Check for regressions -- run the full test suite
  6. Document the root cause -- persist as a learning
FIX VERIFICATION:
[ ] Root cause fix applied (not a workaround)
[ ] Regression test added
[ ] Similar code checked for same pattern
[ ] Originally failing test/gate passes
[ ] Full test suite passes (no regressions)
[ ] Fix does not modify test expectations (unless tests were wrong)

Output format

Every debugging session produces this summary:

debugging_report:
  symptom: "1-line description"
  evidence_count: N
  hypotheses:
    - id: H1
      description: "..."
      result: "confirmed | rejected"
    - id: H2
      description: "..."
      result: "confirmed | rejected"
    - id: H3
      description: "..."
      result: "confirmed | rejected | not_tested"
  root_cause:
    confirmed_hypothesis: "H1 | H2 | H3 | none"
    description: "what actually caused the failure"
    category: "logic_error | data_issue | config_error | race_condition | dependency_change | schema_mismatch | missing_validation"
  fix:
    changes: ["file paths"]
    regression_test_added: true | false
    similar_patterns_checked: true | false
  learning: "what to remember for next time"

After completing the report, persist the learning:

bd remember "<root cause and fix summary>" --key <repo>/trouble/<topic>

Anti-patterns

Anti-PatternDo This Instead
Fix without evidencePhase 1 first. Always.
Single hypothesis3 hypotheses minimum
Modify tests to passTests are the spec. Fix the code.
Retry without understandingSystematic debugging between retries
"It works now" without knowing whyRoot cause must be identified
Quick patch on symptomRoot cause + regression test + similar pattern check
Changing multiple things at onceOne change at a time. Test after each.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.