SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 10-28 16:16

技能介绍

用途

code-review 用于对代码变更进行结构化审查。它审查 HEAD 与用户提供的固定点(commit SHA、分支名、标签、main、HEAD~5 等)之间的 diff,并沿两个独立轴给出结论:

  • Standards:代码是否符合本仓库文档化的编码规范。
  • Spec:代码是否忠实实现了来源 issue / 规格。

两个轴作为并行子智能体运行,避免相互污染上下文,然后由该技能汇总两者的发现。

主要能力

  • 固定点解析:将基准与受审 head 解析为不可变 SHA。对已提交分支使用其 merge-base diff;对请求的工作区改动,将暂存、未暂存及相关未跟踪文件纳入捕获快照并记录其哈希。两个轴审查同一份产物。对已提交范围还会记录提交列表。
  • 前置校验:在继续之前确认固定点可解析(git rev-parse <fixed-point>)且 diff 非空。错误的 ref 或空 diff 应在此处失败,而不是在两个并行子智能体内部失败。
  • 规范来源识别:按顺序查找来源规格——提交信息中的 issue 引用(#123、Closes #45、GitLab !67 等,通过 tracker 文档中的工作流获取)、用户作为参数传入的路径、docs/、specs/ 或 .scratch/ 下与分支名或功能匹配的规格文件。当已接受的请求或调用方提供的简报即为规格时,直接使用。若不存在验收来源,披露“无可用规格”,仅在缺失来源妨碍所请求评估时才询问。
  • 标准来源识别:搜索仓库中所有记录代码应如何编写的文件。当 CODING_STANDARDS.md 或 CONTRIBUTING.md 存在时,必须列入清单。
  • 气味基线:在仓库文档之外,Standards 轴始终携带一组固定的 Fowler 代码气味(《重构》第 3 章),即使仓库未记录任何内容也适用。两条规则约束它:仓库覆盖——文档化的仓库标准始终优先,若仓库标准认可某做法而基线会标记它,则抑制该气味;始终是判断性判断——每个气味都是带标签的启发式(“可能的 Feature Envy”),绝非硬性违规。与任何标准一样,跳过工具已强制执行的项。
  • 并行子智能体:使用 /swarm 在宿主容量内发出两份独立简报并收集最终结果。每份简报包含已解析的评分标准与产物路径。若调用方提供 Pstack 对抗性视角,显式分配它而不替换任一轴;仅对同一产物与范围复用已完成的等效检查。披露原生或顺序回退。
  • 汇总:在 ## Standards 与 ## Spec 标题下呈现两份报告,逐字或轻度清理。不合并或重新排序发现,因为两个轴是刻意分离的。最后以一行摘要结束:每轴的发现总数,以及每轴内最严重的问题(若有)。不跨轴挑选单一赢家。

使用方式

  1. 固定固定点:用户所说的即为固定点。复用调用工作流已提供的固定点。若未确立,提议仓库实际的 merge-base;仅在预期范围模糊时询问。
  2. 识别规格来源(见上)。
  3. 识别标准来源(见上)。
  4. 并行生成两个子智能体:
    • Standards 子智能体简报应包含:完整的 diff 命令与提交列表;第 3 步找到的标准来源文件清单,加上完整粘贴的气味基线(子智能体无法以其他方式访问它);所选原则负责人的已解析指令与适用约束。应用文档化的仓库例外,区分可操作的规则违规与可选的设计偏好。简报内容:“按文件/hunk 报告:(a) diff 违反文档化标准的每一处:引用标准(文件 + 规则);(b) 你发现的任何基线气味:命名并引用该 hunk。区分硬性违规与判断性判断:文档化标准的违反可以是硬性的,但基线气味始终是判断性判断,且文档化的仓库标准覆盖基线。跳过工具已强制执行的项。400 字以内。”
    • Spec 子智能体简报应包含:diff 命令与提交列表;规格的路径或已获取内容;调用方或当前规范产物提供的、已接受的由原则驱动的设计决策及其所需证明。简报内容:“报告:(a) 规格要求但缺失或部分实现的需求;(b) diff 中未被要求的行为(范围蔓延);(c) 看起来已实现但实现有误的需求。为每条发现引用规格行。400 字以内。”
    • 若规格缺失,跳过 Spec 子智能体并在最终报告中注明。
  5. 汇总(见上)。

适用场景

  • 需要同时检查“代码是否合规”与“代码是否做对了事”的变更审查。
  • 有明确来源 issue 或规格文件的开发工作流。
  • 已提交分支或工作区改动的审查。

限制

  • 若规格缺失,Spec 轴无法运行,只能披露“无可用规格”。
  • 若规格要求某个未提供的 tracker,需告知用户运行 /setup-matt-pocock-skills。
  • 基线气味始终是判断性判断,不是硬性违规;文档化的仓库标准覆盖基线。
  • 跳过工具已强制执行的项。
  • 审查请求不授权编辑或公开评论。
  • 若调用工作流在审查后更改了产物,需针对其最终哈希刷新受影响的轴;仅当范围仍然有效时才保留未受影响的证据。
  • 关于收费、价格、平台支持等具体信息,资料中暂未提供。