updating-pr-title-and-description

name	updating-pr-title-and-description
description	Pull Request作成・更新時に使用。タイトルと説明文を自動生成・更新する。
compatibility	Requires gh (GitHub CLI) and git

Pull Requestのタイトルと説明文を更新する

Pull Requestのタイトルと説明文を以下の手順で更新してください。

禁止事項

• 開発日誌（esa.io）のURLをPR descriptionに記載しない: 開発日誌はチーム内の作業記録であり、PRの説明文に含めるべきではない。yasuhisa.esa.io や esa.io ドメインのURLは関連情報セクションにも記載禁止

実行手順

1. デフォルトブランチの取得

   デフォルトブランチを取得：

   git symbolic-ref refs/remotes/origin/HEAD --short | cut -d/ -f2
   

2. 修正内容の確認

   デフォルトブランチからの差分を確認：

   # <default-branch> には手順1で取得したブランチ名を使用
   git diff <default-branch>...HEAD
   

3. コミットメッセージの確認

   デフォルトブランチからのコミット履歴を確認（本文も含む）：

   # <default-branch> には手順1で取得したブランチ名を使用
   git log <default-branch>..HEAD
   

4. 説明文ファイルの準備

   .github/PULL_REQUEST_TEMPLATE.mdが存在する場合はコピー：

   cp .github/PULL_REQUEST_TEMPLATE.md .claude_work/pr_body_draft.md
   

   存在しない場合は新規ファイル作成：

   touch .claude_work/pr_body_draft.md
   

5. Pull Requestの説明文を作成

   • 重要: 説明文を書く前に、必ず reference/description-rules.md を読み、そのルールに従うこと
   • 作業ファイル（.claude_work/pr_body_draft.md）を編集
   • 上記で取得した情報とチャットの会話内容を考慮して説明文を作成
   • 説明文は必ず日本語で記載すること
   • 重要：ファイル編集には必ずWriteツールまたはEditツールを使用すること
   • bashコマンド（cat <<EOF > file、echo "..." > fileなど）でファイルを書き込んではいけません

5.5. CIチェックボックスの確認と記入（PR template使用時）

重要: PR templateにCIチェックボックスがある場合、PR作成/更新前に必ずCI状態を確認してチェックを記入すること。後からの確認は禁止。

a. CIチェックボックスの検出：

.claude_work/pr_body_draft.md内にCIチェックボックスがあるか確認：

grep -iE '- \[ \].*(CI|test|check|テスト)' .claude_work/pr_body_draft.md

b. PRが既に存在する場合のCI状態確認：

PRが存在するか確認し、存在する場合はCI状態を確認：

# PRが存在するか確認
if gh pr view >/dev/null 2>&1; then
  # CI状態を確認
  gh pr checks --json name,conclusion
fi

c. CI状態に基づくチェックボックスの記入：

• 全てのCIチェックが成功（conclusion: SUCCESSまたはSKIPPED）している場合、Editツールでチェックを記入：
  • - [ ] CI → - [x] CI
  • - [ ] テスト → - [x] テスト
  • - [ ] Tests pass → - [x] Tests pass
• 一部でも失敗またはペンディングの場合、チェックを入れない（- [ ]のまま）

d. PRが新規作成の場合：

• この段階ではCIがまだ実行されていないため、チェックボックスは空（- [ ]）のまま
• 手順6でPRを作成した後、CIの完了を待つ必要がある場合は以下を実行：
  1. CI完了を待機：gh pr checks --watch
  2. CI完了後、手順5.5に戻ってチェックを記入
  3. gh pr edit --body-file .claude_work/pr_body_draft.mdでPR説明文を更新

6. リモートへのプッシュとPull Requestの作成または更新

   現在のブランチ名を確認してプッシュ：

   # ブランチ名を確認
   git rev-parse --abbrev-ref HEAD
   # ブランチ名を指定してプッシュ（例: git push origin feature/new-feature）
   git push origin <branch-name>
   

   PRの存在確認と作成/更新：

   # PRが存在するか確認
   if gh pr view >/dev/null 2>&1; then
     # PRが存在する場合：更新
     gh pr edit --title "修正内容を考慮したタイトル" --body-file .claude_work/pr_body_draft.md
   else
     # PRが存在しない場合：ドラフトPRを作成
     gh pr create --draft --title "修正内容を考慮したタイトル" --body-file .claude_work/pr_body_draft.md
   fi
   

7. 更新後の確認と文字化けチェック

   # PRの内容を確認
   gh pr view
   

   • タイトルと説明文が正しく設定されているか確認
   • 文字化けチェック：日本語が文字化けしていないか確認
   • 文字化けが検出された場合：
     1. .claude_work/pr_body_draft.md を確認し、UTF-8エンコーディングで保存されているか確認
     2. ファイルを修正（必要に応じて文字エンコーディングを修正）
     3. 再度 gh pr edit --body-file .claude_work/pr_body_draft.md で更新
     4. もう一度 gh pr view で確認