Git ブランチ命名ガイド

2024年10月30日

Gitにおけるブランチ名は、プロジェクト管理やチームの共同作業の円滑化に非常に重要です。ブランチ名をわかりやすく命名することで、ブランチ一覧が整理され、後からの見直しやメンテナンスが容易になります。以下は、日本語でのブランチ名のサンプルと命名規則のガイドです。

ブランチ名の基本フォーマット

ブランチ名には、プレフィックスを使って変更の種類を明確にすると、ブランチの意図が一目でわかりやすくなります。

推奨されるプレフィックス一覧

• feature/: 新機能の追加
• fix/: バグ修正
• hotfix/: 緊急バグ修正（本番環境への即時反映が必要な場合）
• refactor/: リファクタリング（動作に影響しないコードの改善）
• docs/: ドキュメントのみの変更
• chore/: その他の設定や依存関係の更新

ブランチ名の具体例

新機能追加 (feature)

• feature/ユーザー登録機能
  • ユーザー登録画面とその関連機能を実装するブランチ。
• feature/支払いインテグレーション
  • 支払い処理を外部サービスと連携する機能のブランチ。
• feature/ランキングシステム
  • ランキング表示機能を追加するためのブランチ。

バグ修正 (fix)

• fix/ログインエラーハンドリング
  • ログイン時に発生するエラー処理の改善。
• fix/モバイル表示崩れ
  • モバイルでの表示が崩れる問題を修正するブランチ。
• fix/スコア計算バグ
  • スコア計算の不具合を修正するブランチ。

緊急対応 (hotfix)

• hotfix/重要なセキュリティ修正
  • 重大なセキュリティリスクの修正を行うブランチ。
• hotfix/サーバー接続エラー
  • サーバー接続に関する重大なエラーの即時修正ブランチ。
• hotfix/アプリケーションクラッシュ
  • アプリケーションのクラッシュ問題を緊急修正するブランチ。

リファクタリング (refactor)

• refactor/コード整理_パフォーマンス改善
  • パフォーマンス改善のためにコードを整理するブランチ。
• refactor/データベースクエリ最適化
  • データベースクエリを最適化して効率化するブランチ。
• refactor/共通関数の分離
  • 重複した処理を共通関数として分離し、再利用可能にするブランチ。

ドキュメント更新 (docs)

• docs/README更新
  • プロジェクトのREADMEを更新するブランチ。
• docs/API仕様追加
  • APIの仕様書を追記・更新するブランチ。
• docs/セットアップ手順追記
  • プロジェクトのセットアップ方法をドキュメントに追記するブランチ。

その他の設定変更や依存関係更新 (chore)

• chore/ライブラリバージョン更新
  • 依存しているライブラリを最新バージョンに更新するブランチ。
• chore/ビルド設定調整
  • ビルドや開発環境の設定ファイルを微調整するブランチ。
• chore/不要ファイル削除
  • 不要になったファイルを整理して削除するブランチ。

ブランチ命名のポイント

1. 短くわかりやすい – ブランチ名は変更内容を簡潔に表現し、必要以上に長くならないようにします。
2. 一貫性 – プレフィックスや命名ルールをプロジェクト内で統一することで、ブランチが並んだ際にも目的が明確になり、管理が容易になります。
3. 具体的な内容 – 内容が具体的であるほどブランチの目的が明確になり、チームメンバーにも意図が伝わりやすくなります。

推奨される命名スタイル

• スラッシュを使用して、プレフィックスと内容を区切る。
  • 例: feature/新機能の内容
• 単語間をアンダースコアで区切ることで、複数語を簡潔に表現。
  • 例: fix/表示崩れ修正

まとめ

ブランチ名にプレフィックスと目的を反映することで、管理がしやすく、チームメンバー間での理解も深まります。このガイドを参考に、プロジェクト内での一貫したブランチ名ルールを確立して、より効率的なGit管理を目指しましょう。