mcpField
D
debugging

debugging

github.com/siviter-xyz开发22148 次安装32 周前更新
代码仓库

关于 debugging

debugging 是面向开发者的系统化调试指南,指导从收集错误证据到验证修复的完整过程,并强调最小改动和回归检查。

主要功能

  1. 01收集错误信息与复现步骤
  2. 02定位故障范围
  3. 03基于证据测试假设
  4. 04实施最小修复并验证
  5. 05参考常见错误模式

适用场景

  1. 01调查异常、堆栈跟踪或测试失败
  2. 02复现并定位意外行为
  3. 03排查性能问题或配置错误
  4. 04修复后检查回归并验证 CI

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/siviter-xyz/dot-agent --skill debugging

安装后在 Claude Code 中输入/debugging确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
debugging-tools.md
error-patterns.md
root-cause-analysis.md

详细介绍

调试

系统化地进行根因分析和调试。

适用场景

  • 遇到错误或异常
  • 需要调查测试失败
  • 代码行为异常
  • 出现堆栈跟踪或错误消息
  • 代码行为与预期不同
  • 性能问题或 Bug

核心原则

  • 以证据为依据:根据错误消息、日志和可复现的步骤进行诊断
  • 系统化:遵循结构化的调试流程
  • 最小化修复:实施能够解决问题的最小改动
  • 验证解决方案:确认修复有效,且不会引入回归问题

调试流程

遵循系统化的调试流程:

  1. 收集错误信息(消息、堆栈跟踪、日志、环境)
  2. 确定复现步骤(最少步骤、条件、边缘情况)
  3. 定位故障位置(函数/模块、近期改动、依赖项)
  4. 提出并验证假设(以证据为依据、系统化测试、调试日志)
  5. 实施最小修复(改动最少、保留原有行为、遵循现有模式)
  6. 验证解决方案(问题已解决、没有回归问题、测试通过)

详细方法请参阅 references/root-cause-analysis.md。

有策略地添加调试日志

在入口/出口、状态转换、条件分支、外部 API 调用和数据转换处添加调试日志。问题解决后将其移除,除非这些日志仍有持续价值。

识别错误模式

常见模式包括:null/undefined 错误、类型错误、时序问题、状态损坏和配置问题。详细模式和解决方案请参阅 references/error-patterns.md。

集成

修复后:

  • 确认 CI 检查通过(类型检查、测试、lint)
  • 将相关改动作为原子变更暂存(修复 + 测试)
  • 建议使用语义化提交消息
  • 提交前与用户确认

参考资料

详细指南请参阅:

  • references/root-cause-analysis.md - 系统化分析方法
  • references/error-patterns.md - 常见错误模式和解决方案
  • references/debugging-tools.md - 调试工具和技巧

评论

支持 Markdown