featureブランチの命名規約
feature/プレフィックスにチケット番号と説明的なタイトルを組み合わせた、一貫性のあるfeatureブランチの命名方法を学びます。
Branch Types
詳細な説明
featureブランチの命名
featureブランチは、あらゆるgitワークフローで最もよく使用されるブランチタイプです。コードベースに追加される新機能を表し、通常はdevelopまたはmainブランチから分岐します。
標準フォーマット
feature/{ticket}-{description}
例
| 入力 | 生成されるブランチ名 |
|---|---|
| PROJ-1234 + "Add user authentication" | feature/proj-1234-add-user-authentication |
| #567 + "Implement dark mode toggle" | feature/567-implement-dark-mode-toggle |
| ENG-89 + "API rate limiting" | feature/eng-89-api-rate-limiting |
featureプレフィックスが重要な理由
feature/プレフィックスの使用は、開発ワークフローで複数の目的を果たします：
- 視覚的な整理 —
git branchでブランチを一覧表示する際、featureブランチがアルファベット順にグループ化され、アクティブな作業を簡単に確認できます。 - CI/CD統合 — 多くのCIシステム（GitHub Actions、GitLab CI、Jenkins）はブランチ名パターンに基づいて特定のパイプラインをトリガーできます。
feature/*パターンにより、featureブランチで正しいビルドとテストスイートが実行されます。 - コードレビューのコンテキスト — レビュアーはブランチ名からすぐに目的を理解でき、レビュー開始前にPR説明を読む必要が減ります。
- ブランチ保護ルール — gitホスティングプラットフォームでは「
feature/*にマッチするブランチにはプルリクエストレビューを必須にする」などのルールを設定でき、品質ゲートを強制できます。
良いfeatureブランチ名のコツ
- 説明は3〜5語で、コアとなる変更を捉える
- トレーサビリティのためにプロジェクトトラッカーのチケット番号を使用する
feature/updateやfeature/changesのような汎用的な名前を避ける- 役立つ場合はドメイン領域を含める：
feature/PROJ-123-auth-oauth-google
ユースケース
開発者がOAuth2ログインを実装するための新しいJIRAチケットを担当し、チケットにリンクしつつ作業内容を明確に説明する標準化されたブランチ名が必要です。