mcpField
P
prepare-for-review

prepare-for-review

github.com/opengovsg開発136 回インストール6 週間前に更新
リポジトリ

prepare-for-review について

コード作成者向けに、記録やADR、仕様書の根拠をPR本文とインラインコメント案にまとめるスキルです。内容とプッシュ計画を提示し、明示的な承認後にPRを作成します。

主な機能

  1. 01プロジェクト記録から根拠を収集
  2. 02テンプレートに沿ってPR本文を作成
  3. 03決定記録からインラインコメントを準備
  4. 04フロントエンドのスクリーンショットに対応
  5. 05プッシュとPR作成前に承認を要求

活用シーン

  1. 01レビュー担当者向けに変更理由を整理
  2. 02決定記録をもとにインラインコメントを作成
  3. 03公開前にPR資料を確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/opengovsg/formsg-ai --skill prepare-for-review

インストール後、Claude Code で/prepare-for-reviewを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

SCREENSHOTS.md
TEMPLATE.md
agents/
openai.yaml

詳細

レビューの準備

review を補完する作成者向けの手順です。理由を記録した場所(ブレッドクラム、ADR、仕様書)から、レビュアーが確認する場所(PR の本文、インラインコメント)へ移します。理由を生成するものではないため、情報源が空の場合、そのセクションは省略されます。

docs/agents/ticket-tracker.md と docs/agents/decisions-breadcrumb.md が必要です。見つからない場合は /setup-formsg-ai-skills を実行してください。

ワークフロー

  1. 固定点を決める — ユーザー指定の ref があればそれを使い、なければ main を使います。git diff <fixed-point>...HEAD と git log <fixed-point>..HEAD --oneline を取得します。

  2. 理由の情報源を集める

    • ブレッドクラム:.scratch/<feature>/decisions.md(任意)
    • ADR:差分内のパスに関連する docs/adr/ のファイル
    • 仕様書/チケット:docs/agents/ticket-tracker.md を使ってコミットメッセージの参照先から取得し、参照がない場合は .scratch/<feature>/SPEC.md を確認します。見つからない場合はユーザーに尋ねます。
  3. PR の本文を作成する — TEMPLATE.md に従います。情報源が空のサブセクションは省略します。

  4. スクリーンショット(フロントエンドのみ) — 差分にフロントエンドのファイルが含まれる場合は、SCREENSHOTS.md に従います。

  5. インラインコメントを作成する — kind: inline のブレッドクラムごとに、{ file, line, body } 形式のコメントを1件作成します。形式が不正なエントリ(file/line がないもの)はユーザーに知らせます。

  6. プレビュー — 作成した本文、インラインコメントの一覧、プッシュ計画を表示します。明示的な承認を待ちます。

  7. PR を作成する — 承認後:

    • アップストリームがない場合は git push -u origin <branch>、ある場合は git push
    • gh pr create --title "<title>" --body-file <tmp>
    • gh api repos/{owner}/{repo}/pulls/{n}/comments を使って各インラインコメントを投稿します
    • PR の URL を出力します

コメント