git:create-pr

GitHub CLI を使用してプルリクエストを作成する方法

このガイドでは、プロジェクトで GitHub CLI を使用してプルリクエストを作成する方法を説明します。

重要：PR のタイトルと説明はすべて英語で記述してください。

前提条件

gh がインストールされているか確認してください。インストールされていない場合は、次の手順に従ってインストールしてください。

1. まだインストールしていない場合は、GitHub CLI をインストールします。

   # macOS
   brew install gh
   
   # Windows
   winget install --id GitHub.cli
   
   # Linux
   # Follow instructions at https://github.com/cli/cli/blob/trunk/docs/install_linux.md
   

2. GitHub で認証します。

   gh auth login
   

事前確認

PR を作成する前に、コミットされていない変更がないか確認してください。

1. git status を実行して、コミットされていない変更（ステージ済み、未ステージ、または追跡対象外のファイル）がないか確認します。
2. コミットされていない変更がある場合は、Skill ツールを使用して、まず git:commit コマンドを実行します。

   Skill: git:commit
   

3. これにより、PR を作成する前にすべての作業がコミットされます。

新しいプルリクエストの作成

1. まず、@.github/pull_request_template.md のテンプレートに従って PR の説明を準備します。

2. gh pr create --draft コマンドを使用して、新しいプルリクエストを作成します。

   # Basic command structure
   gh pr create --draft --title "✨(scope): Your descriptive title" --body "Your PR description" --base main 
   

   適切な書式を使った、より複雑な PR の説明には、テンプレートとまったく同じ構成で --body-file オプションを使用します。

   # Create PR with proper template structure
   gh pr create --draft --title "✨(scope): Your descriptive title" --body-file .github/pull_request_template.md --base main
   

ベストプラクティス

1. 言語：PR のタイトルと説明には必ず英語を使用します。

2. PR タイトルの形式：絵文字を付けた conventional commit 形式を使用します。

   • タイトルの先頭には、必ず適切な絵文字を付けます。
   • :sparkles: のようなコード表記ではなく、実際の絵文字を使用します。
   • 例：
     • ✨(supabase): Add staging remote configuration
     • 🐛(auth): Fix login redirect issue
     • 📝(readme): Update installation instructions

3. 説明のテンプレート：@.github/pull_request_template.md にある PR テンプレートの構成を必ず使用します。

4. テンプレートの正確さ：PR の説明がテンプレートの構成に厳密に従っていることを確認します。

   • PR-Agent のセクション（pr_agent:summary と pr_agent:walkthrough）を変更したり、名前を変更したりしないでください。
   • すべてのセクション見出しは、テンプレートにあるとおりに記載してください。
   • テンプレートにないカスタムセクションを追加しないでください。

5. ドラフト PR：作業中の場合は、ドラフトとして開始します。

   • コマンドで --draft フラグを使用します。
   • 完了したら gh pr ready を使用してレビュー可能な状態にします。

よくある間違いとその回避方法

1. 英語以外のテキストを使用する：PR の内容はすべて英語で記述してください。
2. セクション見出しが正しくない：テンプレートのセクション見出しを必ずそのまま使用してください。
3. カスタムセクションを追加する：テンプレートで定義されているセクションのみを使用してください。
4. 古いテンプレートを使用する：必ず現在の @.github/pull_request_template.md ファイルを参照してください。

セクションの欠落

「N/A」や「None」と記載する場合でも、テンプレートのセクションはすべて含めてください。

その他の GitHub CLI PR コマンド

PR の管理に役立つ、その他の GitHub CLI コマンドを紹介します。

# List your open pull requests
gh pr list --author "@me"

# Check PR status
gh pr status

# View a specific PR
gh pr view <PR-NUMBER>

# Check out a PR branch locally
gh pr checkout <PR-NUMBER>

# Convert a draft PR to ready for review
gh pr ready <PR-NUMBER>

# Add reviewers to a PR
gh pr edit <PR-NUMBER> --add-reviewer username1,username2

# Merge a PR
gh pr merge <PR-NUMBER> --squash

PR 作成時のテンプレートの使用

一貫した説明で PR を簡単に作成できるよう、テンプレートファイルを作成できます。

1. PR テンプレートを記載した pr-template.md という名前のファイルを作成します。
2. PR の作成時に使用します。

gh pr create --draft --title "feat(scope): Your title" --body-file pr-template.md --base main

関連ドキュメント

• PR テンプレート
• Conventional Commits
• GitHub CLI のドキュメント