ケバブケースのブランチ命名規約
gitブランチ名にkebab-case(ハイフン区切りの小文字)を使用します。読みやすく、URLセーフなブランチ名のための最も広く採用されている規約です。
Naming Conventions
詳細な説明
gitブランチのkebab-case
kebab-caseは、単語の区切りにハイフンを使用する小文字の表記法です。読みやすさ、URL互換性、Webの標準との一貫性から、gitブランチの命名規約として最も広く採用されています。
フォーマット
type/ticket-number-description-in-kebab-case
例
| 入力 | kebab-caseブランチ |
|---|---|
| Feature: PROJ-123 "Add User Auth" | feature/proj-123-add-user-auth |
| Bugfix: #456 "Fix Memory Leak" | bugfix/456-fix-memory-leak |
| Chore: DEVOPS-78 "Update CI Pipeline" | chore/devops-78-update-ci-pipeline |
kebab-caseが好まれる理由
読みやすさ — ハイフンは、アンダースコア(リンクの下線で隠れることがある)やcamelCase(スキャンしにくい)の曖昧さなしに、単語間の明確な視覚的分離を作ります。
URL安全性 — ハイフンはエンコードなしでURLに安全です。ブランチ名がCIダッシュボードURL、webhookペイロード、デプロイリンクに表示される場合、kebab-caseはどこでもきれいにレンダリングされます。
規約の一貫性 — ほとんどのgitドキュメント、チュートリアル、オープンソースプロジェクトはブランチ名にkebab-caseを使用しています。この規約に従うことで、新しいチームメンバーの摩擦を減らします。
シェルフレンドリー — ハイフンはほとんどのシェルでエスケープを必要とせず、スペース、アンパサンド、クォートなどの文字とは異なります。
他の規約との比較
| 規約 | 例 | 長所 | 短所 |
|---|---|---|---|
| kebab-case | add-user-auth |
最も読みやすい、URLセーフ | チケットIDにハイフンが使えない |
| snake_case | add_user_auth |
Pythonプロジェクトで一般的 | リンクでアンダースコアが隠れる |
| camelCase | addUserAuth |
コンパクト | 長い名前では読みにくい |
ツールの設定
Git Branch Name Generatorはデフォルトでkebab-caseを使用します。すべてのスペース、アンダースコア、連続するハイフンは単一のハイフンに正規化されます。特殊文字は除去され、一貫性のために結果は小文字化されます。
ユースケース
チームリーダーが新しいプロジェクトのブランチ命名ガイドラインを策定し、開発者が参照できる明確な例とともにkebab-caseが推奨される規約である理由を文書化したいと考えています。