SuperAPI AI 工具集

review-conformance

测试与质量

查看项目

更新于 10-17 16:22

技能介绍

用途

review-conformance 用于审查一个变更 diff 是否符合某一个项目指南文件(例如 docs/TEST_GUIDELINES.md、docs/CODE_GUIDELINES.md 等)。一次派发只审查一个指南文件;第二个文件需要第二次派发。

主要能力

  • 将 diff 限制在被管辖的路径内(git diff <range> -- <path>...),逐条检查受管辖路径下每一处变更行是否违反指南条款。
  • 对每一条适用的条款,检查其适用的每一行,而不是抽样检查。
  • 以统一格式输出发现项:finding-N: guideline, <low | medium | high> — <以标题与编号引用的条款,并引用原文> — <file:line>。
  • 严重程度定义:high 表示在正常使用中会丢失工作成果或让本应失败的关卡通过;medium 表示在正常使用中产生误导或使已声明的规则未被满足;low 表示需要罕见或人为构造的状态,或代码本身正确但存在缺口。
  • 报告与“底线”(floor)相矛盾的条款,作为针对该条款的发现项,引用该条款在指南文件中的行号。底线优先;遵守此类违反底线的条款的变更同样构成发现项。
  • 报告不再按原文成立的条款,例如:规则已改但理由未随之更新、条款引用了另一个指南文件或项目不存在的文档。
  • 文件未声明的内容记为 note:,绝不作为发现项;note 不阻塞任何事项。
  • 以结论行结束:按严重程度统计发现项数量,并说明是否存在高于 low 的发现项。

使用方式

开始时声明:“Using the review-conformance skill against .”

前置条件:

  • 被派发时只带一个指南文件、它所管辖的路径以及一个 diff 范围。
  • 没有实现叙述:没有计划、没有派发报告、没有关于代码为何如此的说明。diff 与该文件就是全部依据。
  • 只读取该指南文件与 diff,不读项目其他指导内容:不读另一个指南文件、不读已安装的默认配置、不读某个单元的指南文件或根目录的指南文件来替代。被交付的文件独立成立。
  • 不做任何更改:不编辑、不提交、不创建任务工作树。由另一个智能体修复发现项,下一轮再审查修复。

步骤:

  1. 将 diff 限制在被管辖路径内,逐条检查每一处变更行。
  2. 按统一格式撰写每个发现项,从 1 开始编号。
  3. 报告与底线相矛盾的条款,以及不再按原文成立的条款。
  4. 文件未声明的内容记为 note:。
  5. 以结论行结束。

底线(floor)全文:

  • 每个测试都带有 verifies:;
  • 每个新测试都被观察到先红;
  • 当其所验证的行为被破坏时每个测试都会失败,因此仅断言某个替身被调用的断言,只有在调用本身就是需求时才满足该条;
  • class B 与 C:为每个 REQ 与 LLR 提供异常输入测试;
  • class C:在每个被触及的 SDD 项接口处提供测试;
  • 每个 SDD 项都可追溯到某个 REQ;
  • class C 项具有 LLR;
  • 为不同 class 的项之间的隔离声明了机制;
  • 每个第三方组件都在 soup.md 中;
  • 跨单元依赖在 depends_on: 中声明,class 不同时还需 segregated_from:。

适用场景

  • 需要按单一指南文件严格审查合并变更,且要求审查过程可追溯、不越权。
  • 需要将审查结果与修复分离:审查者只报告,修复由另一个智能体完成。
  • 需要区分“违反已声明规则”与“文件未声明但值得注意”的情况。

限制

  • 一次派发只审查一个指南文件。
  • 只读取被指定的指南文件与 diff,不参考其他指导内容。
  • 不修改任何代码、不提交、不创建任务工作树。
  • 文件未声明的内容只能记为 note:,不能作为发现项。
  • 发现项必须引用条款(标题与编号并引用原文),否则只能算 note。
  • 关于收费、价格、平台、效果等信息,资料中暂未提供。