pr-message-format

PRメッセージの書式ルール

このルールは、Pull Request（PR）のタイトルおよび本文に適用されるガイドラインです。

このルールの位置づけ

• 本ルールは、Conventional Commits をベースにしたコミットメッセージ規約（commit-message-format.mdc）と整合する形で、PR メッセージのフォーマットを定義します。
• タイトルの Prefix やサマリはコミットメッセージと同様のスタイルを推奨しつつ、PR 本文では「概要」「変更内容」「テスト内容」などを構造化して記述することを求めます。
• 他プロジェクトで再利用する場合は、language や必須セクション（例: 「技術的な詳細」）を各プロジェクトのポリシーに合わせて調整してください。

言語指定

• このルールファイルでは、PR メッセージに用いる言語を表す論理名として language を用いる。
• language = "ja"
• タイトルおよび本文は、原則として language で指定した言語で記述する。

タイトル（1行目）

フォーマット（必須）

<Prefix>: <サマリ（命令形/簡潔に）>

• Prefix はコミットメッセージと同様、Conventional Commits における type を用いることを推奨します（例: feat, fix, refactor, docs, chore など）。
• language で指定した言語で簡潔に書く。末尾の句点は不要。
• 何を・なぜ（必要なら）を短く表現し、文字数はおおよそ 50 文字以内を目安にする。

本文（構造化フォーマット）

推奨テンプレート

PR 本文は、以下のような構造化されたセクションを持つことを推奨します。

## 概要

このPRで実装・修正した内容の要約を記載

## 変更内容

- 変更点1の説明
- 変更点2の説明
- 変更点3の説明

## 技術的な詳細（任意）

- 必要に応じて実装の詳細や設計上の意図を記載

## テスト内容

- 実施したテストの種類（ユニットテスト、E2Eテスト、手動確認など）
- 主要な動作確認の結果

## 関連Issue

- Closes #123
- Refs #456

• 「概要」と「変更内容」は原則として必須とし、「技術的な詳細」「テスト内容」「関連Issue」はプロジェクトの運用ルールに応じて必須化してもよい。
• 箇条書きには、できる限り「何を」「どこに」「なぜ」変更したかが分かる粒度で記述する。

メッセージ生成の原則

• PR タイトルおよび本文は、必ず 実際の差分とコミット履歴（例: git diff, git log）を確認したうえで、その内容から要約・構造化して生成する。
• issue タイトルやブランチ名だけから推測して書かず、変更内容・影響範囲・テスト内容を本文に明示する。
• AI やスクリプトによる自動生成の場合も、差分・コミット履歴・関連 Issue 情報を入力として用いる。
• コミットメッセージ規約（commit-message-format.mdc）と整合するように Prefix やサマリを決める（コミットと PR で意味的な不整合が出ないようにする）。

禁止事項

• language で指定した言語と異なる言語だけでタイトルや本文を書くこと
• 意味が伝わらない曖昧なタイトル（例: "update", "fix issue", "changes" などの抽象的な表現）
• 構造化されていない長文だけの本文（セクション見出しや箇条書きがなく、内容の把握が困難なもの）
• 実際の差分と異なる内容や、重要な変更点・影響・テスト結果を意図的に省略した説明