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 ツールを使って最初に commit スキルを実行します。

   Skill: 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 オプションを使い、PR テンプレートの構成を正確に使用します。

   # 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 Commits 形式を使用します。

   • タイトルの先頭には必ず適切な絵文字を付けます。
   • :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 のドキュメント