agentleFS
ali-sheibaali-sheiba/development-workflow/skills/systematic-debugging/SKILL.md

systematic-debugging

Skill1 starsChanged 21 days agoMITView on GitHub

Diagnose a defect, failing test, or regression before fixing it. Use whenever behaviour differs from expectation. Requires reproduction, evidence, one tested root-cause hypothesis at a time, and a fix driven by a failing test. After three failed hypotheses, stop and question the design with the user.

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

8 rules. 0 are common, 7 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 177 edited versions we read keep these.

  • 7

    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. Very specific:

    Run this as the implementer.

    line 8
  2. Distinctive:

    No fix without a reproduction, evidence, and a tested root cause.

    line 12
  3. Distinctive:

    Read the full error, stack trace, and nearby logs.

    line 21
  4. Distinctive:

    If it will not reproduce, add a temporary diagnostic and read it back.

    line 25
  5. Distinctive:

    Use it to locate one causal difference.

    line 32
  6. Distinctive:

    Write it down: "The cause is X, because evidence Y predicts Z."

    line 41
  7. Distinctive:

    Run the smallest experiment that changes one variable.

    line 42
  8. Distinctive:

    If it is disproved, revert the experiment and form a new hypothesis.

    line 43

“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

Systematic Debugging

Run this as the implementer. Send an explorer when you cannot find where a behaviour lives or what a locked dependency really does.

No fix without a reproduction, evidence, and a tested root cause. Do not edit production code while guessing. Guards, retries, delays, and several speculative changes at once are guessing.

1. Reproduce

  1. State the expected and the observed behaviour exactly.
  2. Reproduce with the smallest reliable command. Record inputs, command, output, and how often it happens.
  3. Read the full error, stack trace, and nearby logs.
  4. Trace the bad value back to where it first goes wrong, not where it shows. At a boundary - process, service, database, queue - check both sides.

If it will not reproduce, add a temporary diagnostic and read it back. Do not fix a theory.

2. Compare

Find the closest working example in the project and list every difference - configuration, inputs, lifecycle order, state, transaction boundaries, timing. Use it to locate one causal difference.

Common hiding places: side effects in callbacks, work enqueued inside an open transaction, a query returning empty instead of nothing, repeated per-item queries, an input filter dropping a key, an unapplied migration, a cache that outlives its data.

3. Test one hypothesis

  1. Write it down: "The cause is X, because evidence Y predicts Z."
  2. Run the smallest experiment that changes one variable.
  3. If it is disproved, revert the experiment and form a new hypothesis. Never stack changes.

After three failed hypotheses, stop. Present the evidence and question the design or the assumptions with the user.

4. Fix through a failing test

  • Unplanned bug: the diagnosis is evidence for a plan, not permission to edit. Go through brainstorming and an approved plan, then fix it as a unit.
  • Inside an approved unit: continue.

Under test-driven-development: write a test that reproduces the root cause and watch it fail, make the smallest causal fix, remove temporary diagnostics, then run the full specs and lint once and re-run the original reproduction. Fix the source of the bad state, not only the symptom.

Review findings are evidence, not orders

Reproduce a behavioural finding before you fix it. Check a quality finding against the code and the project's rules. If fresh output shows a finding is wrong, report it rejected with that output. A wrong fix is worse than the finding.

Done when

The failure reproduced (or the limit is recorded), evidence supports the root cause, a regression test failed before the fix and passes after, the final specs and lint run passed, and the report explains why the fix addresses the cause.

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.