以下は、私が使用しているブランチの命名規則とその理由です。
ブランチの命名規則
- ブランチ名の先頭にグループ化トークン (単語) を使用します。
- 短いリード トークンを定義して使用し、ワークフローにとって意味のある方法で分岐を区別します。
- スラッシュを使用して、ブランチ名の一部を区切ります。
- 数字のみを先頭に使用しないでください。
- 存続期間の長いブランチの長い説明的な名前は避けてください。
グループ トークン
ブランチ名の前に「グループ化」トークンを使用します。
group1/foo
group2/foo
group1/bar
group2/bar
group3/bar
group1/baz
グループには、ワークフローに合わせて好きな名前を付けることができます。私は短い名詞を使うのが好きです。より明確にするために読んでください。
明確に定義された短いトークン
短いトークンを選択して、すべてのブランチ名にノイズを追加しすぎないようにします。私はこれらを使用します：
wip Works in progress; stuff I know won't be finished soon
feat Feature I'm adding or expanding
bug Bug fix or experiment
junk Throwaway branch created to experiment
これらの各トークンを使用して、各ブランチがワークフローのどの部分に属しているかを知ることができます。
変更のさまざまなサイクルに対して複数のブランチがあるようです。あなたのサイクルが何であるかはわかりませんが、それらが「新しい」、「テスト中」、および「検証済み」であると仮定しましょう. これらのタグの短縮バージョンを使用してブランチに名前を付けることができます。つづりは常に同じであり、それらをグループ化して、現在どの段階にいるかを思い出させることができます。
new/frabnotz
new/foo
new/bar
test/foo
test/frabnotz
ver/foo
どのブランチがそれぞれの段階に到達したかをすばやく確認でき、Git のパターン マッチング オプションを使用してそれらを簡単にグループ化できます。
$ git branch --list "test/*"
test/foo
test/frabnotz
$ git branch --list "*/foo"
new/foo
test/foo
ver/foo
$ gitk --branches="*/foo"
スラッシュを使用してパーツを区切る
ブランチ名には好きな区切り文字を使用できますが、スラッシュが最も柔軟であることがわかりました。ダッシュまたはドットを使用することをお勧めします。ただし、スラッシュを使用すると、リモートとの間でプッシュまたはフェッチするときに、ブランチの名前を変更できます。
$ git push origin 'refs/heads/feature/*:refs/heads/phord/feat/*'
$ git push origin 'refs/heads/bug/*:refs/heads/review/bugfix/*'
私にとっては、スラッシュは、シェルでのタブ展開 (コマンド補完) にも適しています。私が設定した方法では、パーツの最初の文字を入力して TAB キーを押すことで、異なるサブパーツを持つブランチを検索できます。Zsh は、入力したトークンの一部に一致するブランチのリストを表示します。これは、前のトークンだけでなく、埋め込まれたトークンにも機能します。
$ git checkout new<TAB>
Menu: new/frabnotz new/foo new/bar
$ git checkout foo<TAB>
Menu: new/foo test/foo ver/foo
(Zshell はコマンド補完に関して非常に構成可能であり、ダッシュ、アンダースコア、またはドットを同じように処理するように構成することもできます。しかし、私はそうしないことにしました。)
次のように、多くの git コマンドでブランチを検索することもできます。
git branch --list "feature/*"
git log --graph --oneline --decorate --branches="feature/*"
gitk --branches="feature/*"
警告: Slipp がコメントで指摘しているように、スラッシュは問題を引き起こす可能性があります。ブランチはパスとして実装されるため、「foo」という名前のブランチと「foo/bar」という名前の別のブランチを持つことはできません。これは、新しいユーザーにとって混乱を招く可能性があります。
裸の数字を使用しないでください
ブランチの命名スキームの一部として、裸の数字 (または 16 進数) を使用しないでください。参照名のタブ展開内で、git は番号がブランチ名ではなく sha-1 の一部であると判断する場合があります。たとえば、私の課題トラッカーはバグに 10 進数で名前を付けています。混乱を避けるために、関連するブランチには単に nnnnn ではなく CRnnnnn という名前を付けています。
$ git checkout CR15032<TAB>
Menu: fix/CR15032 test/CR15032
15032 だけを展開しようとすると、git は SHA-1 の名前を検索するのか、ブランチ名を検索するのかわからなくなり、選択肢がいくらか制限されます。
長い説明的な名前を避ける
長いブランチ名は、ブランチのリストを見るときに非常に役立ちます。しかし、装飾された 1 行のログを見ると、ブランチ名が 1 行のほとんどを使い果たし、ログの表示部分を省略できるため、邪魔になる可能性があります。
一方、習慣的に手作業で書き直さない場合、長いブランチ名は「コミットのマージ」でより役立ちます。デフォルトのマージ コミット メッセージはMerge branch 'branch-name'. Merge branch 'fix/CR15032/crash-when-unformatted-disk-inserted'マージ メッセージを だけではなくとして表示する方が便利な場合がありますMerge branch 'fix/CR15032'。
