効率的なレビューのためのPR作成ガイド

PRのレビューがなかなか進まず、開発が止まってしまうことはありませんか？レビュアーが何を見ればいいのか分からなかったり、変更の意図を汲み取るのに時間がかかったりするのは、開発チームにとって大きなストレスです。

良いPRは、レビュアーが素早く意図を理解し、安全に変更をマージできるものです。人間だけでなく、LLMによるレビューも想定した、効率的で精度の高いPR作成のコツを解説します。

必要なもの

• pnpm がインストールされている環境
• コードベースおよび GitHub 内の関連する Issue や修正履歴の検索結果

クイックスタート

5分でできる、質の高いPR作成のステップです。

1. バリデーションの実行: PRを作成する前に、ローカルで以下のコマンドを実行し、エラーをすべて修正してください。
   • pnpm lint
   • pnpm check
   • pnpm build
   • pnpm test
   • Protocol に変更がある場合: pnpm protocol:check
2. タイトルの設定: 動詞: 範囲 + 結果 の形式でタイトルを付けます（例: Docs: add PR and issue templates）。
3. 説明文の記述: 問題点、変更の理由、ユーザーに見える変更点、テスト結果を簡潔にまとめます。このガイドを読んだ証として、説明文の中に lobster-biscuit というキーワードを含めてください。
4. 証拠の追加: 動作を証明するために、ログ、スクリーンショット、または動画（UI/UX変更の場合）を添付します。

PR Templates

以下のテンプレートをコピーして使用してください。状況に合わせてセクションを適宜省略してください。

General PR Template

#### Summary

#### Behavior Changes

#### Codebase and GitHub Search

#### Tests

#### Manual Testing (omit if N/A)

### Prerequisites

-

### Steps

1.
2.

#### Evidence (omit if N/A)

**Sign-Off**

- Models used:
- Submitter effort (self-reported):
- Agent notes (optional, cite evidence):

Fix

#### Summary

#### Repro Steps

#### Root Cause

#### Behavior Changes

#### Tests

#### Manual Testing (omit if N/A)

### Prerequisites

-

### Steps

1.
2.

#### Evidence (omit if N/A)

**Sign-Off**

- Models used:
- Submitter effort:
- Agent notes:

Feature

#### Summary

#### Use Cases

#### Behavior Changes

#### Existing Functionality Check

- [ ] I searched the codebase for existing functionality.
      Searches performed (1-3 bullets):
  -
  -

#### Tests

#### Manual Testing (omit if N/A)

### Prerequisites

-

### Steps

1.
2.

#### Evidence (omit if N/A)

**Sign-Off**

- Models used:
- Submitter effort:
- Agent notes:

トラブルシューティング

• pnpm コマンドが失敗する: PRを作成する前に、すべての失敗を修正する必要があります。特に pnpm lint や pnpm test は必須です。
• レビューの意図が伝わらない: 変更の意図やリスク、検証結果の順番で記述する「段階的な情報開示（Progressive disclosure）」を意識してください。

AI Setup Assistant

次のステップ

• PRテンプレートの詳細
• Issueテンプレートの使い方