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 のプルリクエスト内の特定の行にレビューコメントを追加します。
ステップ 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:複数行コメントの場合、範囲の最初の行
ベストプラクティス
-
メンテナーがワンクリックで適用できる簡単な修正には、提案ブロック(3 つのバッククォート + "suggestion")を使用します
```suggestion <suggested code here> ```注:提案ブロックでは、元のインデントを正確に保持してください
-
同じ問題が繰り返し発生している場合は、すべての箇所を指摘するのではなく、代表的な 1 つのコメントを残します
-
バグについては、起こりうる問題と推奨する修正を明確に説明します
コメント
Markdown 対応