SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 10-16 06:28

技能介绍

用途

Code Review 是一个用于审查代码变更的技能,目标是分析 diff 中的缺陷、安全问题和正确性问题,并以结构化形式返回发现结果。它只做分析,不应用修复。

主要能力

  • 根据上下文确定审查目标:未提交的更改(--uncommitted)、与基础分支对比(--base <branch>)、或指定提交(--commit <sha>)。默认与仓库的默认分支对比,可通过 gh repo view --json defaultBranchRef --jq '.defaultBranchRef.name' 检测默认分支。
  • 对每个变更文件读取足够的上下文以理解改动。
  • 应用严格的缺陷判定标准,只标记同时满足以下条件的问题:对代码的准确性、性能、安全或可维护性有实质影响;问题是离散且可操作的;修复不需要超出代码库现有水平的严谨度;问题由本次变更引入;作者若知晓很可能会修复;不依赖对代码库或作者意图的未声明假设;有可证明受影响的具体代码;明显不是作者的有意改动。
  • 按优先级分级:P0(放下一切,阻塞发布或运维,仅限不依赖输入假设的普遍问题)、P1(紧急,应在下个周期处理)、P2(正常,最终修复)、P3(低,锦上添花)。
  • 忽略琐碎风格问题(除非影响理解或违反文档化标准)以及本次变更未引入的既有问题。

使用方式

  1. 确定 diff 目标:未提交更改、对比基础分支或指定提交,默认对比仓库默认分支。
  2. 运行相应的 diff 命令获取变更。
  3. 对每个变更文件读取足够上下文。
  4. 应用缺陷判定标准,按输出格式返回结果。

输出格式为编号列表,每条发现包含:标题(命令式,不超过 80 字符,带优先级标记)、文件路径与行号范围、一段说明(解释为何是缺陷、触发场景与影响)。所有发现之后附上总体结论,包含正确性判定(correct 或 incorrect)及 1-3 句说明。若无符合条件的发现,则说明代码看起来正确并简要解释。

评论标准

清楚说明为何是缺陷;准确传达严重程度,不夸大;正文最多一段;代码片段不超过 3 行;明确说明触发缺陷所需的场景、环境或输入;语气客观,不指责也不过度正面;让作者无需细读即可理解;不使用奉承性语言。

适用场景

适用于对代码变更进行自动化或辅助审查,帮助发现由本次变更引入的缺陷、安全与正确性问题,并给出可操作的优先级排序。

限制

不应用修复,仅返回发现结果。不标记既有问题或琐碎风格问题。判定依赖可证明受影响的代码,不接受推测。具体支持的平台、收费方式等信息暂未提供。