Skip to main content

AIによるPRレビューの導入

PRをAIがレビューするときの観点は、リポジトリ間で置き場所と見出しを揃える。 人間向けのコメント温度感はPull Request時のレビューについてを正とする。

このリポジトリの正本は.github/review-guidelines.mdである。 Gitの作業手順はワークフローを正とする。

方針​

  1. 正本は全リポジトリで.github/review-guidelines.mdとする。見出しは「共通の前提」「重大度」「リポジトリ固有の観点」「過去の指摘」に揃える。中身だけをリポジトリごとに変える
  2. AGENTS.mdに## Code Review Rulesを置く。見出し名は変更しない。CodexのGitHub PRレビューはこの見出しを読む。専用ファイルは読まない
  3. CursorオートメーションはクラウドエージェントとしてAGENTS.mdとオートメーションのプロンプトに従う。プロンプトでは正本を読むよう指定する
  4. 観点を複数ファイルに分けるのは、場所ごとにルールが大きく異なる場合（モノレポなど）に限る。その場合はサブディレクトリのAGENTS.mdから、その場所の正本を参照する
  5. Cursor Bugbotは.cursor/BUGBOT.mdと、そこからリンクした.mdを読む。未使用なら作らない

導入手順​

  1. 次の雛形を.github/review-guidelines.mdへコピーし、リポジトリ固有の観点と過去の指摘を埋める
  2. ルートのAGENTS.mdに## Code Review Rulesを追加する。正本へのリンクと、外せない2〜3項目だけを直接書く
  3. Cursorオートメーションを使う場合は、プロンプト例を設定する
  4. Bugbotを使う場合だけ、.cursor/BUGBOT.mdに1行の参照を置く
  5. モノレポで場所ごとにルールが異なる場合のみ、パッケージ直下などへ正本を分け、その配下のAGENTS.mdから参照する

レビュー観点の雛形​

コードフェンスはtextにする。 markdownフェンスの強調表示クラスは、Tailwindと衝突することがある。

.github/review-guidelines.md
# PRレビュー観点

このファイルは、Cursor、Codex、Geminiなど、どのツールでレビューしても同じ基準にするための正本である。
レビューを始める前に通読する。

`AGENTS.md`の`## Code Review Rules`は、Codexが読むための要約である。
詳細はこのファイルを正とする。

## 共通の前提

- 表記、文体、フォーマットはリンターとフォーマッターが検査する。レビューでは機械で判断できない中身を見る
- レビューは指摘だけにする。修正やマージは人が判断する

## 重大度

各指摘には重要度と根拠（ファイルと行）を付ける。

- **高**: 誤り、破損、対象の取り違えなど、マージ前に判断が必要である
- **中**: 正本とのずれ、導線の欠落、設定の食い違いなど、直した方がよい
- **低**: 表現の明確化など、必須ではない

## リポジトリ固有の観点

（このリポジトリで機械検査できない確認項目を書く）

## 過去の指摘

（再発を防ぐための実例を、PR番号と短い事実で書く）

Code Review Rulesの雛形​

ルートのAGENTS.mdに次を置く。 見出しは## Code Review Rulesのままにする。

AGENTS.md
## Code Review Rules

PRをレビューするときは `.github/review-guidelines.md` を正本とする。
先に通読し、同じ観点で指摘する。

- レビューは指摘だけにする。修正やマージは人が判断する。
- 各指摘には重要度（高・中・低）と根拠（ファイルと行）を付ける。
- （リンターが検査しない、このリポジトリ固有の外せない項目を1つ書く。）

Cursorオートメーションのプロンプト例​

オートメーションのプロンプトに、正本を読む指示を入れる。 観点の全文はプロンプトへ複製しない。

このリポジトリのPRをレビューする。
AGENTS.mdの「Code Review Rules」と`.github/review-guidelines.md`を先に読む。
指摘だけを返す。修正やマージはしない。
各指摘に重要度（高・中・低）と根拠（ファイルと行）を付ける。

Bugbotを使う場合の例​

Bugbotを導入するときだけ、次の1行を.cursor/BUGBOT.mdに置く。 未使用ならファイルは作らない。

.cursor/BUGBOT.md
PRレビューの観点は`.github/review-guidelines.md`を正とする。

モノレポでの分割​

複数ファイルに分けるのは、場所ごとにルールが大きく異なる場合に限る。 分割した場合の正本も、見出し構成は共通のままにする。

例：packages/web/.github/review-guidelines.mdをその場所の正本とする。 packages/web/AGENTS.mdの## Code Review Rulesからそのパスを参照する。 ルートのAGENTS.mdへ全文は複製しない。

Last updated on