SuperAPI AI 工具集

review-pr

编程与开发

查看项目

更新于 10-16 07:21

技能介绍

用途:审查当前 PR,将审查结论写入 review.json,由工作流负责发布,技能本身不向 GitHub 直接提交评论或评审。工作目录为 PR 分支检出,工作流通常提供 pr_diff.txt 注释差异与 pr_description.txt 描述;若存在 spec_context.md 则用于实现与规格的对照校验,可通过 .agents/skills/review-pr/scripts/resolve_spec_context.py 按需生成。

主要能力:聚焦本 PR 变更的文件与行,优先检查正确性、安全性、错误处理和实质性性能问题,且将评论质量与测试质量视为同等优先事项。若仓库提供本地安全审查配套技能或提示要求安全审查,将其作为补充并合并到同一 review.json;存在规格上下文时可结合本地 check-impl-against-spec 技能,把明显的规格偏离作为审查关注点。仅在有具体建议块时给出风格或细枝末节评论;涉及未改动代码的担忧写入顶层正文。V0 或初始实现的健壮性建议(超时、重试、生命周期管理)一般作为可选后续工作,除非涉及正确性、安全或数据丢失。

使用方式:审查前主动查找仓库是否提供 review-pr-local 配套技能(如 .agents/skills/review-pr-local/SKILL.md,位置或命名可能不同),若有则读取并按其约定执行,但它不得改动输出 JSON schema、严重级别标签、安全规则、证据规则、建议块约束或差异行注释契约。差异文件前缀含义:[OLD:n] 为旧侧删除行,用 LEFT;[NEW:n] 为新侧新增行,用 RIGHT;[OLD:n,NEW:m] 为未变上下文,用 RIGHT 加第 m 行。内联评论位置只能以此注释为唯一依据,无法定位具体注释行时改为写入顶层正文。

评论要求:每条评论正文必须以 🚨 [CRITICAL](缺陷、安全、崩溃、数据丢失)、⚠️ [IMPORTANT](逻辑、边界、缺失错误处理)、💡 [SUGGESTION](改进或更好模式)、🧹 [NIT](仅含建议块的清理)之一开头。评论应简洁、直接、可执行,不加恭维或模糊措辞,优先单行,行范围不超过 10 行,且只针对差异中显式出现的行与文件。确认违反仓库评论或测试指南本身即可判为 ⚠️ [IMPORTANT]。

建议块规则:使用 suggestion 代码块给出替换代码,需匹配原文件缩进,仅包含替换内容,块内容恰好替换 start_line 至 line(含)的范围,不得包含范围外行,不得以紧邻上方的行开头或以紧邻下方的行结尾;需核对括号与块定界符层级一致;多行建议设置 start_line/start_side 为首行、line/side 为末行。

输出格式:创建 review.json,字段含必填 verdict(必须为大写 "APPROVE" 或 "REJECT"):Approve 或 Approve with nits 映射为 "APPROVE",Request changes 映射为 "REJECT";必填顶层 body,用于评审概述与最终建议,需含 PR 高层概述、重要关注与无法内联的未改动代码关注、按 Found: X critical, Y important, Z suggestions 格式的问题计数,以及最终建议(Approve / Approve with nits / Request changes),且须与 verdict 一致;comments 为必填数组,无内联评论时用空数组,path 相对仓库根,line 必填且需对应正确侧,start_line 可选仅用于多行范围且提供时 start_side 必填为 LEFT 或 RIGHT。

限制:不要运行 gh pr review、gh pr comment、gh api 或任何向 GitHub 发布的命令;最终输出仅为 review.json。判定前需完成预审:逐条列出差异新增或修改的注释并对照仓库注释规范,逐一检查差异新增或修改的测试是否符合仓库测试规范。返回或上传前需校验 JSON 合法、确认行号与注释差异一致,并运行验证器:python3 .agents/skills/review-pr/scripts/validate_review_json.py --review-json review.json --diff pr_diff.txt;若脚本不在该确切位置,在已加载的 review-pr 技能目录下查找 validate_review_json.py 并用相同参数运行,验证器通过前不得返回或上传 review.json。配套 review-pr-local 技能的具体位置、命名及本地 check-impl-against-spec 技能是否可用,取决于具体仓库,资料未提供统一约定;其他缺失事实暂未提供。