commit-pr — コミットメッセージ / PR 本文ジェネレータ
git の変更を読み取り、規約に沿ったコミットメッセージ、または PR 本文を生成する。 ユーザーに明示的に依頼されるまで commit / push はしない(CLAUDE.md のワークフロー規約)。
モード判定
- コミットモード: 「コミット」「コミットメッセージ」 → メッセージを生成(依頼があれば実行)
- PR モード: 「PR」「プルリク」「マージリクエスト」 → PR タイトル+本文を生成
両方求められたら コミット → PR の順。
進め方(コミットモード)
- 変更を把握する
git statusとgit diff(staged が無ければ unstaged)を読む- staged が空なら、ユーザーに
git addの要否を確認する(勝手に add しない)
- 変更を論理単位で捉える。無関係な変更が混在していれば指摘し、分割コミットを提案する
- このリポジトリの規約に合わせる
- 直近のコミット履歴(
git log --oneline -15)を読み、prefix と言語スタイルを踏襲する - このリポジトリは日本語+
feat:fix:perf:refactor:docs:chore:等
- 直近のコミット履歴(
- メッセージを生成する
- 1 行目:
<type>: <要約>(命令形・簡潔、72 文字目安) - 本文(必要時のみ): 「何を・なぜ」を箇条書き。「どう」はコード参照
- 1 行目:
- ユーザーに提示する。実行依頼があれば commit する
- main ブランチ上なら、先にブランチ作成を提案する(CLAUDE.md 準拠)
- コミット末尾に Co-Authored-By 行を付ける運用なら従う
進め方(PR モード)
- ベースブランチとの diff を把握する(
git log/git diff <base>...HEAD) - PR タイトル: コミットと同じ規約の 1 行
- PR 本文の構成:
## 概要 - 何を・なぜ(1〜3 行) ## 変更点 - 主要な変更を箇条書き(ファイル/モジュール単位) ## テスト - 実行した確認・テスト結果(無ければ「未実施」と正直に書く) ## 補足 - レビュー時の注意点・既知の制約(あれば) gh pr createを使う場合はコマンドを提示。実行はユーザー依頼後
原則
- diff に無い変更を本文ででっち上げない。事実だけを書く
- テスト未実施なら「未実施」と書く(やったことにしない)
- 秘密情報(キー・トークン)が diff に含まれていたら commit せず警告する