agentleFS
syangasyanga/astack/skills/diagnosing-bugs/SKILL.md

diagnosing-bugs

Skill0 starsChanged 54 days agoMITView on GitHub

Diagnose failures and performance regressions, or analyze captured profiles, traces, and heap snapshots.

193 other projects use a version of this, 157 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use setup-ts-deep-modules, loop-me and 9 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.
  • liufeng1976Skill

    setup-ts-deep-modules

    Wire dependency-cruiser into a TypeScript repo so each package is a deep module — implementation hidden in subfolders, reachable only through its entry-point files. User-invoked.

    Also in 43 projects that use this

  • RoentekSkill

    loop-me

    Grill me about specs for the workflows I want to build, within this workspace.

    Also in 55 projects that use this

  • LesaniSkill

    writing-beats

    Shape an article as a journey of beats, choose-your-own-adventure style. The user picks a starting beat from the raw material, you write only that beat, then offer options for where to pivot next, beat by beat, until the article reaches a natural end. Use when the user has raw material and wants to assemble it as a narrative rather than an argument.

    Also in 58 projects that use this

  • AWSSkill

    to-questionnaire

    Turn a decision you can't fully answer into a questionnaire for someone else to fill in.

    Also in 88 projects that use this

  • LesaniSkill

    writing-shape

    Take a markdown file of raw material and shape it into an article through a conversational session — drafting candidate openings, growing the piece paragraph by paragraph, arguing about format (lists, tables, callouts, quotes) at each step. Use when the user has a pile of notes, fragments, or a rough draft and wants help turning it into something publishable.

    Also in 56 projects that use this

  • ryotaroh180105Skill

    claude-handoff

    Hand the current conversation off to a fresh background agent that picks up the work immediately.

    Also in 41 projects that use this

  • +1 more from Lesani

The file

Show its rules and text

We split this skill into the rules it gives an agent

15 rules. 11 are common, 3 are distinctive, and 1 is very specific to this project.

  • 11

    Common

    Most of the 181 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read Fix Root Causes. For regression tests, follow tdd and Test Behavior, Not Implementation.

    line 10
  2. Very specific:

    When exploring the codebase, read CONTEXT.md (if it exists) to get a clear mental model of the relevant modules, and check ADRs in the area …

    line 18
  3. Distinctive:

    If the redacted output is not enough to diagnose the bug, say so and ask the user.

    line 24
  4. Common:

    Property / fuzz loop: If the bug is "sometimes wrong output", run 1000 random inputs and look for the failure mode.

    line 40
  5. Common:

    Bisection harness: If the bug appeared between two known states (commit, dataset, version), automate "boot at state X, check, repeat" so …

    line 41
  6. Common:

    Differential loop: Run the same input through old-version vs new-version (or two configs) and diff outputs.

    line 42
  7. Common:

    Treat the loop as a product.

    line 49
  8. Distinctive:

    Read enough code to construct the loop.

    line 74
  9. Common:

    Run the loop. Watch it go red as the bug appears.

    line 78
  10. Common:

    Do not proceed until you have reproduced and minimised.

    line 94
  11. Common:

    If you cannot state the prediction, the hypothesis is a vibe: discard or sharpen it.

    line 104
  12. Common:

    Debugger / REPL inspection: if the env supports it. One breakpoint beats ten logs.

    line 114
  13. Common:

    Never "log everything and grep".

    line 116
  14. Common:

    Write the regression test before the fix, but only if there is a correct seam for it.

    line 126
  15. Common:

    If a correct seam exists:

    line 132

“Common” is measured: kept by at least 6 in 10 of the 181 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

Diagnosing bugs

A discipline for hard bugs. Skip phases only when explicitly justified. A diagnosis-only request ends with evidence and a proposed fix.

Read Fix Root Causes. For regression tests, follow tdd and Test Behavior, Not Implementation.

For an existing capture, follow trace forensics instead of requiring a new reproduction loop. For live profiling, follow runtime forensics. Those paths may return a provisional diagnosis; they do not establish that a fix works.

The phases below apply to a runnable failure. Reuse reproduction evidence already gathered by the caller. Honor its scope: a read-only inquiry permits existing checks and evidence analysis, not code edits or instrumentation. When a needed experiment exceeds that scope, return the gap and proposed experiment. For a requested fix, bug-fix owns delivery; for optimization, perf-issue owns the measurement comparison. Continue the current diagnosis without recursively restarting those workflows.

For a session transfer, read handoff. Include the reproduction command or capture, hypotheses tested, remaining probes, and cleanup state.

When exploring the codebase, read CONTEXT.md (if it exists) to get a clear mental model of the relevant modules, and check ADRs in the area you're touching.

Redact

This skill has you show commands, outputs and captured artifacts. Redact every secret first: write <REDACTED> in its place. Build loops against env vars, so the credential stays in the environment rather than in what you show. Captured artifacts carry auth headers: quote only the lines that carry the signal.

If the redacted output is not enough to diagnose the bug, say so and ask the user.

Phase 1: Build a feedback loop

This is the skill. Everything else is mechanical. If you have a tight pass/fail signal for the bug (one that goes red on this bug), you will find the cause; bisection, hypothesis-testing, and instrumentation all just consume it. If you don't have one, no amount of staring at code will save you.

Spend disproportionate effort here. Be aggressive. Be creative. Refuse to give up.

Ways to construct one, in roughly this order

  1. Failing test at whatever seam reaches the bug: unit, integration, e2e.
  2. Curl / HTTP script against a running dev server.
  3. CLI invocation with a fixture input, diffing stdout against a known-good snapshot.
  4. Headless browser script (Playwright / Puppeteer) that drives the UI and asserts on DOM/console/network.
  5. Replay a captured trace. Save a real network request / payload / event log to disk; replay it through the code path in isolation.
  6. Throwaway harness. Spin up a minimal subset of the system (one service, mocked deps) that exercises the bug code path with a single function call.
  7. Property / fuzz loop. If the bug is "sometimes wrong output", run 1000 random inputs and look for the failure mode.
  8. Bisection harness. If the bug appeared between two known states (commit, dataset, version), automate "boot at state X, check, repeat" so you can git bisect run it.
  9. Differential loop. Run the same input through old-version vs new-version (or two configs) and diff outputs.
  10. HITL bash script. Last resort. If a human must click, drive them with scripts/hitl-loop.template.sh so the loop is still structured. Copy the template and edit its steps for the authorized environment before running it. Capture observations, and leave signing in to the user as a step. Captured output feeds back to you.

Build a loop that reaches the actual failure before choosing a fix.

Tighten the loop

Treat the loop as a product. Once you have a loop, tighten it:

  • Can I make it faster? (Cache setup, skip unrelated init, narrow the test scope.)
  • Can I make the signal sharper? (Assert on the specific symptom, not "didn't crash".)
  • Can I make it more deterministic? (Pin time, seed RNG, isolate filesystem, freeze network.)

A 30-second flaky loop is barely better than no loop; a 2-second deterministic one is tight, a debugging superpower.

Non-deterministic bugs

The goal is not a clean repro but a higher reproduction rate. Loop the trigger 100×, parallelise, add stress, narrow timing windows, inject sleeps. Measure the reproduction rate and record the workload, seed, and trial count. Raise the rate without changing the failure being investigated.

When you genuinely cannot build a loop

Say so explicitly and list what you tried. Ask for the missing environment access or a redacted captured artifact (HAR file, log dump, core dump, or screen recording with timestamps). Continue useful read-only investigation, but label its hypotheses unverified. Production instrumentation requires explicit authorization. Do not treat the reproduction gate as passed without a loop.

Completion criterion: a tight loop that goes red

Phase 1 is done when the loop is tight and red-capable: you can name one command (a script path, a test invocation, a curl) that you have already run at least once (show the invocation and its output, redacted), and that is:

  • Red-capable: it drives the actual bug code path and asserts the user's exact symptom, so it can go red on this bug and green once fixed. Not "runs without erroring"; it must be able to catch this specific bug.
  • Deterministic: same verdict every run (flaky bugs: a pinned, high reproduction rate, per above).
  • Fast: seconds, not minutes.
  • Agent-runnable: you can run it unattended; a human in the loop only via scripts/hitl-loop.template.sh.

Read enough code to construct the loop. Treat early theories as provisional until runtime evidence supports them. Proceed to Phase 2 only with the red-capable command; otherwise use the missing-loop procedure above.

Phase 2: Reproduce + minimise

Run the loop. Watch it go red as the bug appears.

Confirm:

  • The loop produces the failure mode the user described, not a different failure that happens to be nearby. Wrong bug = wrong fix.
  • The failure is reproducible across multiple runs (or, for non-deterministic bugs, reproducible at a high enough rate to debug against).
  • You have captured the exact symptom (error message, wrong output, slow timing) so later phases can verify the fix actually addresses it.

Minimise

Once it's red, shrink the repro to the smallest scenario that still goes red. Cut inputs, callers, config, data, and steps one at a time, re-running the loop after each cut, and keep only what's load-bearing for the failure.

Why bother: a minimal repro shrinks the hypothesis space in Phase 3 (fewer moving parts left to suspect) and becomes the clean regression test in Phase 5.

Done when every remaining element is load-bearing: removing any one of them makes the loop go green.

Do not proceed until you have reproduced and minimised.

Phase 3: Hypothesise

Generate competing ranked hypotheses before testing any of them. Aim for 3–5 when the evidence supports distinct explanations; do not invent alternatives to meet a quota. Single-hypothesis generation anchors on the first plausible idea.

Each hypothesis must be falsifiable: state the prediction it makes.

Format: "If <X> is the cause, then <changing Y> will make the bug disappear / <changing Z> will make it worse."

If you cannot state the prediction, the hypothesis is a vibe: discard or sharpen it.

Show the ranked list to the user before testing. They often have domain knowledge that re-ranks instantly ("we just deployed a change to #3"), or know hypotheses they've already ruled out. Cheap checkpoint, big time saver. Don't block on it; proceed with your ranking if the user is AFK.

Phase 4: Instrument

Each probe must map to a specific prediction from Phase 3. Change one variable at a time.

Tool preference:

  1. Debugger / REPL inspection if the env supports it. One breakpoint beats ten logs.
  2. Targeted logs at the boundaries that distinguish hypotheses.
  3. Never "log everything and grep".

Tag every debug log with a unique prefix, e.g. [DEBUG-a4f2]. Cleanup at the end becomes a single grep. Untagged logs survive; tagged logs die.

Perf branch. For performance regressions, logs are usually wrong. Instead: establish a baseline measurement (timing harness, performance.now(), profiler, query plan), then bisect. Measure first, fix second.

Phase 5: Fix + regression test

Continue into implementation only when it is authorized. For diagnosis-only work, report the supported cause, evidence, unresolved hypotheses, and proposed fix or next experiment. Then perform the cleanup below that applies to your probes.

Write the regression test before the fix, but only if there is a correct seam for it.

A correct seam is one where the test exercises the real bug pattern as it occurs at the call site. If the only available seam is too shallow (single-caller test when the bug needs multiple callers, unit test that can't replicate the chain that triggered the bug), a regression test there gives false confidence.

If no correct seam exists, that itself is the finding. Note it. The codebase architecture is preventing the bug from being locked down. Flag this for the next phase.

If a correct seam exists:

  1. Turn the minimised repro into a failing test at that seam.
  2. Watch it fail.
  3. Apply the fix.
  4. Watch it pass.
  5. Re-run the Phase 1 feedback loop against the original (un-minimised) scenario.

Phase 6: Cleanup

After a fix:

  • Original repro no longer reproduces (re-run the Phase 1 loop). For intermittent bugs, compare before/after failure rates and trial counts; zero observed failures alone does not prove impossibility.
  • Regression test passes (or absence of seam is documented)
  • The hypothesis that turned out correct is stated in the commit or PR message, so the next debugger learns

For diagnosis and fixes alike:

  • Temporary instrumentation and runtime patches you introduced are removed, preserving unrelated work. Search for your [DEBUG-...] prefix.
  • Retain evidence needed to reproduce or explain the finding. Remove disposable experiments, and report retained artifact paths or any cleanup still pending.

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.