诊断错误
- 作者仓库星标 0
- 作者更新于 2026年8月24日 14:19
- 作者仓库 skills
- 领域
- 工程开发
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @mattpocock · 未声明许可证
- 上下文用量评级
- 中等消耗
- 接入复杂程度
- 即装即用
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- Windows
- 运行环境要求
- 未检出明确要求
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 读取环境变量
- 网络行为
- 允许外网请求
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
这就是技巧。其他一切都是机械的。如果您对该错误有严格的通过/失败信号(在_this_错误上变红的信号),您将找到原因;二分法、假设检验和仪器仪表都只会消耗它。如果你没有,再多的盯着代码也救不了你。在这里花费不成比例的努力。要有侵略性。要有创意。拒绝放弃。
运行循环。当错误出现时,观察它变红。确认:[ ] 循环产生用户描述的故障模式,而不是附近恰好发生的不同故障。错误的错误=错误的修复。 [ ] 故障可以在多次运行中重现(或者,对于非确定性错误,可以以足够高的速率重现以进行调试)。 [ ] 您已经捕获了确切的症状(错误消息、错误输出、缓慢的计时),因此后续阶段可以验证修复是否确实解决了该问题。
在测试任何假设之前,先生成 3-5 个排名假设。 单一假设的生成基于第一个看似合理的想法。
每个探针必须映射到第 3 阶段的特定预测。一次更改一个变量。工具首选项:调试器/REPL 检查(如果环境支持)。一个断点胜过十个日志。在区分假设的边界处有针对性的记录。永远不要“记录所有内容并 grep”。
在修复之前编写回归测试,但前提是有正确的接缝。正确的接缝是测试在调用站点发生的真实错误模式的测试。如果唯一可用的接缝太浅(当错误需要多个调用者时进行单调用者测试,无法复制触发错误的链的单元测试),则那里的回归测试会给出错误的置信度。如果不存在正确的接缝,那么这本身就是发现的结果。注意它。代码库架构正在防止错误被锁定。将其标记为下一阶段。
声明完成之前需要: [ ] 原始重现不再重现(重新运行第 1 阶段循环) [ ] 回归测试通过(或记录了无缝的缺失) [ ] 删除了所有`[DEBUG-...]` 工具(`grep` 前缀) [ ] 删除了一次性原型(或移动到明确标记的调试位置)
# Diagnosing Bugs
A discipline for hard bugs. Skip phases only when explicitly justified.
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. Captured output feeds back to you.
Build the right feedback loop, and the bug is 90% fixed.
### 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. A 50%-flake bug is debuggable; 1% is not, so keep raising the rate until it's debuggable.
### When you genuinely cannot build a loop
Stop and say so explicitly. List what you tried. Ask the user for: (a) access to whatever environment reproduces it, (b) a redacted captured artifact (HAR file, log dump, core dump, screen recording with timestamps), or (c) permission to add temporary production instrumentation. Do **not** proceed to hypothesise 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`.
If you catch yourself reading code to build a theory before this command exists, **stop: jumping straight to a hypothesis is the exact failure this skill prevents.** No red-capable command, no Phase 2.
## 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 **3–5 ranked hypotheses** before testing any of them. 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
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
Required before declaring done:
- [ ] Original repro no longer reproduces (re-run the Phase 1 loop)
- [ ] Regression test passes (or absence of seam is documented)
- [ ] All `[DEBUG-...]` instrumentation removed (`grep` the prefix)
- [ ] Throwaway prototypes deleted (or moved to a clearly-marked debug location)
- [ ] The hypothesis that turned out correct is stated in the commit / PR message, so the next debugger learns
按说明文件中的顺序排列。
编辑
第一阶段:建立反馈循环
大致按以下顺序构建一个方法
拉紧环
不确定性错误
文件/命令 -> CONTEXT.md · <REDACTED> · git bisect run · scripts/hitl-loop.template.sh · [DEBUG-a4f2] · performance.now() · [DEBUG-...] · grep
内容校验值 -> 7239907abb09
当前原文的自动摘译,尚未人工审校。
编辑
该技能可以让您显示命令、输出和捕获的工件。首先编辑每个秘密:在其位置写入
<REDACTED>。针对环境变量构建循环,以便凭证保留在环境中,而不是您显示的内容中。捕获的工件带有 auth 标头:仅引用携带信号的行。如果经过编辑的输出不足以诊断错误,请说明并询问用户。大致按以下顺序构建一个方法
任何接缝处的测试失败都会导致错误:单元、集成、e2e。针对正在运行的开发服务器的 Curl / HTTP 脚本。使用固定输入进行 CLI 调用,将标准输出与已知良好的快照进行比较。无头浏览器脚本(Playwright / Puppeteer)驱动 UI 并在 DOM/控制台/网络上进行断言。重播捕获的跟踪。将真实的网络请求/负载/事件日志保存到磁盘;通过隔离的代码路径重播它。
拉紧环
将循环视为产品。一旦你有了_a_循环,就收紧它:我可以让它更快吗? (缓存设置,跳过无关的init,缩小测试范围。)我可以让信号更清晰吗? (断言特定症状,而不是“没有崩溃”。)我可以使其更具确定性吗? (固定时间、种子 RNG、隔离文件系统、冻结网络。)30 秒的片状循环仅比没有循环好一点; 2 秒的确定性是严格的,具有调试超能力。
不确定性错误
目标不是干净的复制,而是更高的复制率。将触发器循环 100 倍、并行化、增加压力、缩小计时窗口、注入睡眠。 50% 的错误是可调试的; 1% 则不然,因此请继续提高速率,直到可以调试为止。