agentleFS
ethosagentethosagent/ethos/skills/software-development/systematic-debugging/SKILL.md

systematic-debugging

Skill22 starsChanged 8 days agoMITView on GitHub

Four-phase root-cause investigation — Investigate → Analyze → Hypothesize → Verify → Implement. No fix lands without a confirmed root cause and a regression test that would have caught the original failure.

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

10 rules. 0 are common, 9 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 177 edited versions we read keep these.

  • 9

    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:

    When the cause is obvious from a one-line error message and a one-line fix exists, do not invoke the full procedure — just fix it.

    line 37
  2. Very specific:

    Write all of this down — into the conversation or, for longer investigations, into .ethos-work/investigations/<slug>.md in the workspace …

    line 51
  3. Distinctive:

    If the evidence is thin, return to step 1.

    line 57
  4. Distinctive:

    Run the experiments. The result either confirms a hypothesis or invalidates it.

    line 65
  5. Distinctive:

    If all hypotheses are invalidated, return to step 1 — the data was not enough.

    line 67
  6. Distinctive:

    Before writing a fix, verify the chosen hypothesis with a final concrete test:

    line 71
  7. Distinctive:

    Only now do you have a confirmed root cause.

    line 78
  8. Distinctive:

    Run the full test suite. Do not move on until all tests pass.

    line 87
  9. Distinctive:

    Remove the boundary logging when the bug is confirmed and a regression test is in place.

    line 93
  10. Distinctive:

    If the user asks you to skip the test "because we're in a hurry", refuse and explain that you'll skip the test only when explicitly …

    line 105

“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

Investigation discipline. The fix is the last step, not the first.

When to use this skill

  • The user reported a bug, error, regression, or "X was working yesterday".
  • A terminal command unexpectedly failed and the cause is not immediately obvious.
  • The user said "debug this" / "why is X broken" / "track this down".

When the cause is obvious from a one-line error message and a one-line fix exists, do not invoke the full procedure — just fix it. Reserve this skill for problems where the root cause is unclear.

The four phases

1. Investigate — gather evidence

Collect, do not theorize:

  • The exact error message and stack trace, copied verbatim.
  • Recent changes: git log --since="1 week" --oneline, git diff <last-known-good>...HEAD.
  • Related files: search for the failing identifier with search_files.
  • Environment: relevant env vars, library versions, OS specifics.
  • Reproduction: what minimal input triggers it? Capture the smallest repro.

Write all of this down — into the conversation or, for longer investigations, into .ethos-work/investigations/<slug>.md in the workspace (see "Persisting investigations").

2. Analyze — group the evidence

Group what you collected by what each piece tells you about what is actually happening. Cluster similar errors. Note what's not there (e.g. "no entry in the access log" is a finding, not noise).

If the evidence is thin, return to step 1. Do not skip ahead to hypotheses with insufficient data.

3. Hypothesize — name 1-3 candidate root causes

A hypothesis is a sentence of the form: "X is happening because Y, which is observable as Z."

  • Rank by likelihood given the evidence.
  • For each, design a small experiment that would distinguish it from the others.
  • Run the experiments. The result either confirms a hypothesis or invalidates it.

If all hypotheses are invalidated, return to step 1 — the data was not enough.

4. Verify — confirm the root cause

Before writing a fix, verify the chosen hypothesis with a final concrete test:

  • Reproduce the failure deterministically.
  • Apply the proposed fix locally.
  • Confirm the failure no longer reproduces.
  • Confirm no other behaviour regressed.

Only now do you have a confirmed root cause.

5. Implement

Two parts, both required:

  1. The fix. Smallest change that addresses the root cause. No collateral cleanup.
  2. A regression test. A test that would have caught the original failure. Without this, the fix is invisible — the next regression slips through.

Run the full test suite. Do not move on until all tests pass.

Per-boundary logging

While investigating, prefer adding entry/exit logging at component boundaries (function boundaries, network boundaries, queue boundaries) over scattering console.log inside a single function. The signal-to-noise is much higher: you see what crossed the boundary, not the internal arithmetic.

Remove the boundary logging when the bug is confirmed and a regression test is in place.

Persisting investigations

For non-trivial investigations, write the log to .ethos-work/investigations/<slug>.md in the workspace. Include: the symptoms, the evidence collected, the hypothesis tested, the root cause, and the fix. Future investigations of similar bugs benefit from being able to grep this directory.

.ethos-work/ is the workspace's scratch directory, kept out of git by adding .ethos-work/ to .git/info/exclude. Do not write under ~/.ethos: a personality's default fs_reach lets write_file write only its own personality directory and its working directory (deriveFsReachPaths in packages/core/src/fs-reach.ts), so a write there is refused.

The iron rule

No fix lands without a confirmed root cause and a regression test. A bug fix without a test that would have caught the original is not really fixed — it just isn't visible right now.

If the user asks you to skip the test "because we're in a hurry", refuse and explain that you'll skip the test only when explicitly authorized as a hotfix-with-followup, and only if a follow-up task is created to add the test.

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.