GitHub Issue番号からのGitブランチ名
GitHub Issue番号(#123)からブランチ名を作成します。合理化されたプルリクエストワークフローのためにブランチをIssueに自動的にリンクします。
Integration Patterns
詳細な説明
GitHub Issueのブランチ名
GitHub Issueは#プレフィックス付きのシンプルな番号で参照されます(例:#123、#4567)。ブランチ名にIssue番号を含めることで、GitHubのIssue-PR自動リンクが有効になり、クリーンな監査証跡の維持に役立ちます。
標準フォーマット
{type}/{issue-number}-{description}
例
| Issue | タイトル | ブランチ名 |
|---|---|---|
| #123 | ダークモードサポートの追加 | feature/123-add-dark-mode-support |
| #456 | 壊れた検索の修正 | bugfix/456-fix-broken-search |
| #789 | 依存関係の更新 | chore/789-update-dependencies |
| #1011 | APIレート制限の追加 | feature/1011-add-api-rate-limiting |
GitHubの自動リンク
Issue番号を含むブランチからプルリクエストを作成すると、GitHubはいくつかの自動動作を提供します:
- PRでのIssue参照 — PRサイドバーにリンクされたIssueが表示されます
- マージ時の自動クローズ — PR説明(またはコミットメッセージ)に「Closes #123」や「Fixes #123」を追加すると、PRマージ時にIssueが自動的にクローズされます
- Developmentセクション — Issueページの DevelopmentサイドバーにリンクされたブランチとPRが表示されます
GitHub CLI統合
生成されたブランチ名をGitHub CLIと組み合わせることで、シームレスなワークフローが実現できます:
# ブランチを作成してトラッキングを設定
git checkout -b feature/123-add-dark-mode-support
# Issueを参照するPRを作成
gh pr create --title "Add dark mode support" --body "Closes #123"
GitHubワークフローの命名のコツ
- #プレフィックスを除去する — gitブランチ名に
#は含められません(一部のコンテキストでコメント文字として扱われます)。ツールは自動的に削除し、番号のみを保持します。 - 番号の位置 — 一貫性のために、Issue番号をタイププレフィックスの直後に配置:
feature/description-123ではなくfeature/123-description。 - Organizationリポジトリ — 多くの貢献者がいるリポジトリでは、ユーザー名の追加を検討:
feature/username/123-description。
ユースケース
オープンソースのメンテナーが、プロジェクトボードでどのブランチがどのIssueに対処しているかを簡単に追跡できるよう、GitHub Issueにリンクする一貫したブランチ命名パターンに貢献者が従うことを望んでいます。