关于 add-review-comment
此技能用于在 GitHub 拉取请求的指定行添加评审评论,支持单行和多行评论,并提供撰写可执行建议及合并重复问题反馈的指导。
主要功能
- 01发布单行评论
- 02发布多行评论
- 03定位新增或删除的行
- 04支持建议代码块
适用场景
- 01针对特定变更行发表评论
- 02提供维护者可直接应用的行内修复建议
- 03对重复问题仅报告一个代表性实例
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ mlflow/ mlflow --skill add-review-comment安装后在 Claude Code 中输入/add-review-comment确认已加载。
详细介绍
添加评审评论
为 GitHub Pull Request 中的特定行添加评审评论。
步骤 1:定位要评论的行
使用 fetch-diff 技能(可选择通过 grep 管道处理)来定位要评论的行。
步骤 2:发布评论
单行评论:
gh api repos/<owner>/<repo>/pulls/<pr_number>/comments \
# Body must end with "🤖 Generated with Claude" on a separate line
-f body=<comment> \
-f path=<file_path> \
-F line=<line_number> \
-f side=<side> \
-f commit_id="$(gh pr view <pr_number> --repo <owner>/<repo> --json headRefOid -q .headRefOid)" \
--jq '.html_url'
多行评论:
gh api repos/<owner>/<repo>/pulls/<pr_number>/comments \
# Body must end with "🤖 Generated with Claude" on a separate line
-f body=<comment> \
-f path=<file_path> \
-F start_line=<first_line> \
-f start_side=<side> \
-F line=<last_line> \
-f side=<side> \
-f commit_id="$(gh pr view <pr_number> --repo <owner>/<repo> --json headRefOid -q .headRefOid)" \
--jq '.html_url'
参数
line:文件中的行号(多行时为范围的最后一行)side:新增或修改的行(+)使用RIGHT,删除的行(-)使用LEFTstart_line/start_side:多行评论时,范围的第一行
最佳实践
-
对于可由维护者一键应用的简单修复,使用建议代码块(三个反引号加 "suggestion")
```suggestion <suggested code here> ```注意:在建议代码块中须完全保留原始缩进
-
对于重复出现的问题,只留一条有代表性的评论,而不是逐一标记每个实例
-
对于缺陷,清晰说明潜在问题和建议的修复方法
评论
支持 Markdown