工程开发
sherlock-review avatar

sherlock-review

基于证据的调查性代码审查,使用演绎推理来验证实现声明、调查错误,并透过系统性观察进行根本原因分析。

简介

Sherlock-review 是一种专业的质量工程技能,专为法庭式代码分析和开发者主张的严格验证而设计。它采用福尔摩斯式的软件维护方法,要求代理在对错误修复、功能实现或性能改进下结论之前,必须收集经验证据。该技能超越了表层阅读,要求代码必须被执行并通过独立测试验证,以确保代码确实执行了 PR 说明中所声称的操作。此工具适用于资深工程师、质量保证专家和调查人员,他们需要解决技术报告中的歧义,并确保修复方案解决的是根本原因而非症状。对于“在我的机器上能运行”不足以作为解释的高风险调试会议特别有效。

  • 使用 git diff、日志分析和本地测试执行进行自动化证据收集。

  • 实现结构化的三步调查工作流程:观察(收集数据)、演绎(比较主张与现实)和结论(附带证据的判决)。

  • 对调查结果实行严格的分类系统:TRUE、PARTIALLY TRUE、FALSE 或 NONSENSICAL。

  • 强制执行最低调查结果权重门槛,确保每次调查都能产生可操作的高质量情报。

  • 提供标准化的调查模板,以确保报告和文档的一致性。

  • 具备与车队协调工具的整合功能,允许根据主张类型触发并行的领域特定审核(如安全性、性能、测试)。

  • 始终优先考虑可重现性;只信任通过验证测试断言的代码。

  • 准备好识别危险信号,例如静默吞噬错误、在玩具数据集上进行性能测试,或使用临时变通方案代替真正的架构修复。

  • 此技能需要访问存储库的 git 历史记录、测试套件和环境特定的运行时配置。

  • 对于所有报告,请使用提供的调查模板,以维持其他自动化流水线代理预期的输出格式。

  • 若调查结果暗示系统性疏忽或重复的架构故障,可结合 brutal-honesty-review 使用。

仓库统计

Star 数
329
Fork 数
65
Open Issue 数
4
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年4月28日 12:37
在 GitHub 查看