用途:使用 GitHub API 向 Pull Request 提交结构化代码审查反馈,可在指定代码行上添加行内评论、一键应用的建议块和优先级标签。
主要能力:支持单行与多行行内评论(用 start_line 与 line 指定替换范围)、suggestion 代码建议块、🔴 Critical / 🟠 Important / 🟡 Suggestion 三级优先级标签,以及 APPROVE、COMMENT、REQUEST_CHANGES 三种审查事件。
使用方式:先用 gh 与 JSON 输入文件创建审查数据,再执行 gh api -X POST repos/{owner}/{repo}/pulls/{pr_number}/reviews --input /tmp/review.json。必须使用 --input 而非 -F 参数,以避免评论正文中引号、反引号、换行等特殊字符的 shell 转义问题。commit_id 用 git rev-parse HEAD 获取;path 为 diff 中的文件路径;line 为新版本行号;side 用 RIGHT 表示新增行、LEFT 表示删除行。若 gh 不可用,可用 curl 携带 GITHUB_TOKEN 调用同一 API 端点。
关键规则:所有评论必须合并到一次 review API 调用中,不要逐条单独提交。默认在代码正确且可合并时使用 APPROVE;仅在存在需要处理的问题时使用 COMMENT 或 REQUEST_CHANGES。不要提交“看起来不错”之类的无行动价值评论。
限制与注意:suggestion 块会替换目标范围,写错 start_line/line 与建议正文的组合会导致代码重复或丢失;发布前须用 sed 读取将被替换的实际行并核对结果与描述一致,无法确定时改用普通行内评论。Windows PowerShell 的等价写法见 references/windows.md。资料未提供该扩展的安装方式、收费与平台支持信息。