以下是我使用的一些分支命名约定及其原因
分支命名约定
- 在分支名称的开头使用分组标记(单词)。
- 以对您的工作流程有意义的方式定义和使用短线索标记来区分分支。
- 使用斜杠分隔分支名称的各个部分。
- 不要使用裸数字作为前导部分。
- 避免长寿命分支的长描述性名称。
组令牌
在分支名称前使用“分组”标记。
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/*'
对我来说,斜杠也更适合我的 shell 中的制表符扩展(命令完成)。按照我的配置方式,我可以通过键入部件的第一个字符并按 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/*"
警告:正如斯利普在评论中指出的那样,斜线可能会导致问题。因为分支是作为路径实现的,所以不能有一个名为“foo”的分支和另一个名为“foo/bar”的分支。这可能会让新用户感到困惑。
不要使用裸数字
不要使用裸数字(或十六进制数字)作为分支命名方案的一部分。在引用名称的制表符扩展中,git 可能会确定数字是 sha-1 的一部分,而不是分支名称。例如,我的问题跟踪器使用十进制数字命名错误。我将我的相关分支命名为 CRnnnnn 而不仅仅是 nnnnn 以避免混淆。
$ git checkout CR15032<TAB>
Menu: fix/CR15032 test/CR15032
如果我尝试仅扩展 15032,git 将不确定我是否要搜索 SHA-1 或分支名称,并且我的选择会受到一定限制。
避免长描述性名称
当您查看分支列表时,长分支名称会非常有用。但是在查看装饰的单行日志时,它可能会妨碍,因为分支名称会占用大部分单行并缩写日志的可见部分。
另一方面,如果您不习惯手动重写它们,那么长分支名称在“合并提交”中会更有帮助。默认的合并提交消息是Merge branch 'branch-name'
. 您可能会发现将合并消息显示为Merge branch 'fix/CR15032/crash-when-unformatted-disk-inserted'
而不是仅显示Merge branch 'fix/CR15032'
.