SuperAPI AI 工具集

pr-comment

编程与开发

查看项目

更新于 10-16 04:34

技能介绍

用途:pr-comment 用于向 GitHub Pull Request 发布友好的评审评论。核心流程为:本地讨论 → 准备友好评论 → 试运行预览 → 用户确认 → 原子提交。控制面(SKILL.md)负责对话、语气与编排,数据面(JS 脚本)负责校验、API 调用与安全。

主要能力:从对话上下文收集评论,每条评论需包含 path(文件路径,必填)、line(行号,正整数,必填)、side(RIGHT 新代码或 LEFT 已删除,默认 RIGHT)、body(评论内容,必填)。prepare 阶段会校验路径是否属于变更文件、行号是否为正整数、内容是否非空,并输出校验摘要与预览。提交前通过 AskUserQuestion 获取用户批准,再以原子评审方式提交。

语气规则:用提问代替命令(如“would it make sense to”而非“change this to”);针对代码而非人;解释原因;假设善意;先肯定再建议;除非用户明确要求否则不用 emoji;跟随 PR 使用的语言。内部按 Conventional Comments 分类(suggestion、question、issue、nitpick、praise),不在输出中显示。

使用方式:将评论写入临时 JSON 文件后运行 prepare:bash scripts/run-skill.sh pr-comment pr-comment.js prepare --pr <N> --repo <owner/repo> --input <comments.json>;确认后保存 prepare 输出(含 payload)到临时文件并运行 submit:bash scripts/run-skill.sh pr-comment pr-comment.js submit --pr <N> --repo <owner/repo> --input <payload.json>。

退出码:0 成功并报告评审 URL;2 错误(含 422);3 表示 SHA 漂移,需提示用户并重新 prepare、重新确认、重新提交。

不适用场景:读取已有 PR 评审评论用 /load-pr-review;自动代码评审用 /codex-review-fast 或 /codex-review;创建 PR 用 /create-pr;PR 状态概览用 /pr-summary。

限制:需具备 GitHub API 访问与 gh 命令环境;评论必须对应变更文件中的有效行;提交前必须经用户确认;SHA 漂移时需重新准备。其余细节暂未提供。