/git-pr
プッシュ済みのブランチからプルリクエストを作成(既存PRがあれば更新)
使用方法
code
/git-pr [--base BASE_BRANCH] [--draft]
引数:
- •
--base BASE_BRANCH: ベースブランチを指定(省略時: デフォルトブランチ) - •
--draft: ドラフトPRとして作成
例:
code
/git-pr # デフォルトブランチに通常PR /git-pr --draft # ドラフトPRとして作成 /git-pr --base feature/xxx-xxx # featureブランチをベースに通常PR /git-pr --base feature/xxx-xxx --draft # featureブランチをベースにドラフトPR
実行内容
1. 状態確認
- •
git statusで現在のブランチを確認 - •
gh pr list --head [current-branch]で既存PRの有無を確認
2. 差分確認
- •
git diff [base]...HEADでベースブランチからの差分を確認- •差分が大きい場合は
--name-onlyで変更ファイル一覧を取得後、個別に確認 - •変更内容を把握してからPR説明文を作成
- •差分が大きい場合は
3A. 既存PRがない場合(新規作成)
- •
gh pr list --limit 5で最近のPRから言語慣例(日本語/英語)を確認 - •プルリクエストテンプレート(.github/pull_request_template.md)があれば参照
- •プロジェクトの言語慣例に従ってタイトルと説明を決定(下記ガイドライン参照)
- •
gh pr createでPRを作成:- •
--baseオプション: 指定されたベースブランチ(省略時はデフォルト) - •
--draftオプション: 指定された場合のみドラフトPRとして作成
- •
3B. 既存PRがある場合(更新判定)
- •
gh pr viewで現在のPRタイトル・説明を取得 - •差分内容と現在のPR説明を比較し、乖離がないか確認:
- •新しいコミットが追加されている
- •PR説明に記載されていない変更がある
- •PR説明が古い実装内容を参照している
- •乖離がある場合、更新内容を提案しユーザーに確認
- •承認されれば
gh pr editでタイトル・説明を更新
PR説明のガイドライン
含めるべき内容
- •What(何を): 変更内容の要約。コードを読まずに理解できる程度
- •Why(なぜ): 背景・理由。コードから読み取れない情報
- •関連リンク: Issue番号、設計文書など(該当する場合)
- •スクリーンショット: UI変更の場合
含めないもの
- •実装の詳細な順序(レビュアーに不要)
- •コードの詳細説明(コード内コメントにすべき)