--- name: create-pr description: Create a GitHub pull request using gh CLI, following the repository's own PR template and language conventions disable-model-invocation: true --- # Create PR gh CLI を使ってプルリクエストを作成する汎用スキル。**言語・セクション構成・セクション見出し・特殊コメント(Copilot 指示など)は、すべてリポジトリ側の PR テンプレートと慣習に従う**。スキル自身は書き方を固定しない。 ## 前提の収集 PR 作成の前に以下を確認する。 1. **PR テンプレートの実在と中身**: ```bash cat .github/pull_request_template.md 2>/dev/null || \ cat .github/PULL_REQUEST_TEMPLATE.md 2>/dev/null || \ ls .github/PULL_REQUEST_TEMPLATE/ 2>/dev/null ``` - テンプレートが**ある**なら、そのセクション構成・見出しをそのまま使う。コメント (``) の指示も保持する。 - テンプレートが**ない**なら、`gh pr list --state all --limit 5 --json title,body` で直近の PR を見て慣習的なフォーマットを推定する。 - どちらも見つからなければ下記の**最小構成**で作る: ```markdown ## Summary ## Test Plan - [ ] <確認した動作 1> - [ ] <確認した動作 2> ``` これを既定とし、リポジトリの特性に応じて `## Notes` や `## Screenshots` を追加してよい。 2. **言語の選択**(以下の優先順): 1. テンプレート本体と同じ言語(テンプレートが日本語なら日本語、英語なら英語) 2. 直近 PR 本文の多数派の言語 3. リポジトリの `CLAUDE.md` / `AGENTS.md` / `CONTRIBUTING.md` に言語指定があれば従う 4. 上記いずれでも判断できなければユーザーに確認 - **タイトルと本文は原則同じ言語で揃える**。Conventional Commits の `type(scope):` プレフィックスは英語のまま残してよい(例: `fix(auth): ログインリダイレクトを修正`)。 3. **ブランチ・コミット・差分の把握**: ```bash git branch --show-current git log ..HEAD --oneline git diff ...HEAD --stat ``` `` は通常 `main`(`gh repo view --json defaultBranchRef --jq .defaultBranchRef.name` で確認可能)。 ## 作成手順 1. **ブランチを push**(upstream 未設定の場合): ```bash git push -u origin ``` 2. **PR 本文を用意**: - テンプレートがあれば `cp .github/pull_request_template.md /tmp/pr-body.md` してから編集する。 - 各セクションに情報を埋める。空セクションでも "N/A" を入れて**省略しない**(テンプレート遵守のため)。 - テンプレート内の HTML コメント(Copilot へのレビュー指示、Dependabot の bot 指示、pr_agent 用マーカーなど)は**削除・改変しない**。 3. **PR 作成**: ```bash gh pr create --draft \ --title "type(scope): 簡潔なタイトル" \ --body-file /tmp/pr-body.md \ --base ``` - 本文が単純なら `--body` でもよいが、改行・コードブロックを含むならファイル経由が安全。 - **原則ドラフト** (`--draft`) で作成する。完成したら `gh pr ready ` で切り替える。 4. **確認**: ```bash gh pr view --json title,body,isDraft,url ``` ## タイトル規約 - Conventional Commits (`type(scope): subject`) を既定とする。絵文字なし。 - `type`: `feat` / `fix` / `docs` / `chore` / `refactor` / `style` / `test` / `perf` / `build` / `ci` - ただし**リポジトリの既存 PR タイトルに別の慣習が強く見られる場合はそれに従う**(例: チケット番号プレフィックス・絵文字ありの運用)。 - タイトルの**本文部分**は本文と同じ言語で書く (日本語運用の repo なら日本語)。`type(scope):` は英語のまま。 ## テンプレート遵守の鉄則 - **見出しをリネームしない**(Copilot / pr_agent / Dependabot 等の bot がセクション名を正規表現でパースしている可能性がある)。 - **テンプレートにないセクションを追加しない**。追加情報は既存セクション内に収める。 - **HTML コメントを削除しない**。bot の挙動を制御していることが多い。 - **全セクションを埋める**。内容がなければ "N/A" / "なし" 等を入れる。 - **bot マーカーのあるセクションは "N/A" で埋めない**。`` / `` / `` のように **bot が自動で中身を埋めるためのマーカー**(プレースホルダー専用コメント)がセクション内の唯一の内容である場合、そのコメントだけを残して人間は書き足さない。上の「全セクションを埋める」ルールはこの種のコメントで既に埋まっていると判断してよい。判別できない場合 (例: 自由記述のための `` のようなガイドコメント) は通常どおり人間が埋める。 ## 言語切り替え時の注意 - タイトルを途中で英語→日本語に切り替えた場合、**本文も同じ言語に揃え直す**。混在はレビュアーに読みづらい。 - ユーザーが「本文を日本語に」と指示したら、タイトルもその言語に合わせるか確認する。逆も同じ。 ## よく使う gh CLI コマンド ```bash gh pr list --author "@me" # 自分が開いた PR gh pr status # 現ブランチに紐づく PR 状態 gh pr view # PR の詳細 gh pr view --json title,body # タイトル・本文を JSON で取得 gh pr edit --title "..." --body-file ... # 後から編集 gh pr edit --add-reviewer user1,user2 # レビュアー追加 gh pr ready # Draft → Ready gh pr checks # チェック状況 gh pr merge --squash # マージ (必要なら --auto) ``` ## ありがちなミス - **テンプレートを読まずに PR を作る** → 見出しが独自になり bot が動かない。必ず `cat` してから埋める。 - **言語を固定してしまう** → 日本語運用 repo で英語本文を生成。テンプレとコメントから判定する。 - **HTML コメントを消す** → `` を含むコメントは bot 制御なので保持する。 - **空セクションを省略** → テンプレの構成が崩れる。"N/A" で残す。 - **タイトルと本文の言語不一致** → レビュアー体験を損なう。揃える。 - **`--body` でヒアドキュメント・改行を直接渡す** → シェルエスケープで壊れることがある。複雑な本文は `--body-file` で。 - **ドラフトを経ずにいきなり Ready で作る** → 誤作成時の取り消しコストが高い。原則 `--draft`。