ブランチ命名規約
ブランチ名の統一性を確保し、プロジェクトの管理を容易にするため、以下の規則に従ってブランチ名を命名してください。
基本ルール
使用可能なブランチ名の種類は次のとおりです。これ以外の命名は禁止します。
\p{issue_id}
=[0-9]+
: GitHubのIssue ID\p{summary}
=[a-z0-9-]+
: 概要を英語で書く\p{date(yyyymmdd)}
=[0-9]{8}
: 作成日(作業開始日)\p{commit_hash}
=[a-f0-9]{7,40}
: コミットハッシュ
Feature
- 機能開発用
- 新機能の開発や改善作業で使用します。
feature/{issue_id}-{summary}-{date(yyyymmdd)}
- 例: issue IDが
10
の場合
feature/10-add-api-nameabc-20250316
Bugfix
- 本番環境バグ対応用
- 本番環境で発生したバグを修正するために使用します。
bugfix/{issue_id}-{summary}-{date(yyyymmdd)}
- 例: issue IDが
15
の場合
bugfix/15-fix-login-error-20250316
Hotfix
- 緊急の修正対応
- 本番環境で発生した致命的な不具合に対し、緊急対応を要する場合に使用します。
hotfix/{issue_id}-{summary}-{date(yyyymmdd)}
- 例: issue IDが
20
の場合
hotfix/20-critical-security-patch-20250316
Revert
- 変更の取り消し用
- 過去のコミットを取り消す際に使用します。
revert/{commit_hash}-{date(yyyymmdd)}
- 例: コミットハッシュが
abcd123
の場合
revert/abcd123-20250316
使用可能文字
- アルファベット小文字 (
a
-z
) - 数字 (
0
-9
) - ハイフン (
-
)
必ず ケバブケース(単語同士をハイフンで繋ぐ)を使用してください。
使用禁止文字
- 大文字 (
A-Z
) - スペース (
- アンダースコア (
_
) - その他記号 (
!
,@
,#
,$
,%
,^
,&
,*
,(
,)
, 等)
注意事項
- ブランチ名は可能な限り明確かつ簡潔にしてください。
- issueがない場合は省略せず、必ずissueを作成したうえでブランチを作成してください。
- 一度作成したブランチの名前を変更することは禁止します。