SuperAPI AI 工具集

review-protocols

编程与开发

查看项目

更新于 10-16 06:08

技能介绍

Review Protocols 是一套面向代码审查流程的技能,用于在运行或设计审查过程时提供结构化的方法论。它的出发点是一个核心的不对称性:被要求找问题的审查者,不管问题是否真实存在都会找出问题;而被要求证明代码没问题的怀疑者,则会发现审查者遗漏的守卫条件。因此该技能的做法是,先用一组智能体生成发现项,再把每条发现交给独立的验证者,这些验证者被提示去反驳该发现,只有经得起反驳的发现才会被报告。文中指出这并非冗余:三名都被问「这里有 bug 吗」的审查者会产生相关误差,而一名审查者加两名反驳者才构成一次真正的检验。

在视角分离方面,该技能要求给每位审查者一个狭窄的职责范围。一个对所有内容都发表意见的视角会稀释成风格评论,真正的缺陷会淹没其中。资料给出的视角与其对应问题包括:正确性(对每个可达输入是否都如其所声称的那样工作)、安全(攻击者能否让它做不该做的事)、测试(这些测试能否捕获此处的破坏)、API 契约(是否会破坏依赖它的东西)、性能(随数据或负载增长是否会变差)、文档(这次 diff 使什么变得不成立)。各视角彼此盲审,因为共享上下文会让它们趋同,而趋同恰恰是独立审查者身上不想要的结果。

证据标准要求每条发现都需要具体的失败场景:特定输入或状态,导致错误输出或崩溃。资料给出的正面示例是「user.id 在第 114 行被解引用,守卫在第 121 行。GET /users/:id 传入未知 id → TypeError → 返回 500 而不是 404」;反面示例包括「这里可能有空指针问题」「这在规模上可能是个问题」「考虑加错误处理」。资料明确说明:写不出失败场景的发现只是猜测,应当丢弃,因为一条不可证伪的发现给作者带来的时间成本大于其节省的时间。

在验证与法定人数方面,默认使用 3 名验证者,一条发现若无法被其中 2 名反驳则存活。验证者在不确定时默认判定为 REFUTED。资料解释这是因为误报会让作者对整个审查板失去信任,而漏掉一条发现只损失一个审查周期,两者并不对称,默认值应反映这一点。要确认一条发现,验证者必须指出具体哪个反驳尝试失败了,例如「调用链中任何地方都没有守卫,已在 src/a.ts:41 和 src/b.ts:88 核实」,而不能只说「我找不到守卫」。资料列出的标准反驳检查项包括:函数更早处或调用方已有守卫、类型系统已排除、路径从任何入口都不可达、前置条件由验证或数据库约束或构造不变量保证、所述输入无法到达所述行、已有测试覆盖、框架已处理。

严重性分级分为四档:BLOCK(数据丢失、可达路径上的崩溃、可被利用、静默的错误结果,动作为 REQUEST_CHANGES)、REQUEST(边界情况错误、无界资源、缺少回归测试,动作为 COMMENT)、SUGGEST(脆弱但正确、属改进,动作为 COMMENT)、PRAISE(值得重复的模式,无动作)。SUGGEST 上限为 5 条,超过后会挤占阻断性发现的位置,而这恰恰是本末倒置的。

综合阶段要求按根因而非文本来去重,因为两个视角常常从不同角度描述同一个缺陷,应合并为一条同时携带两种表述的发现。同时必须报告被丢弃的数量及原因,这能让作者知道审查板是经过校准的而非仅仅是沉默,也能暴露出系统性出错的视角。发布时应当只提交一条待审评论,所有行内评论都附在其中,最终一次性提交,绝不逐条评论。相关技能还包括 pr-craft(评论与回复纪律)以及 ../commands/review.md(运行此协议的命令)。

关于收费、价格、具体平台支持范围与使用步骤等信息,资料中暂未提供。