Git工作流程:分支的命名规则

124 阅读2分钟

在日常使用Git时有一些最佳实践,我知道这些技巧和窍门肯定会影响我的团队和我们在开发新功能、修复bug和审查代码时的日常工作流程。

有些技巧和窍门真的很简单,只不过是常识而已,还有一些需要一点Git知识,在所有情况下,我都会提供一些例子,以便更好地理解和说明这些技巧或窍门背后的原理。

请注意,我们遵循功能分支的工作流程,所以所有的提示都是基于这个工作流程的。

让我们开始吧。

分支的命名规则

命名分支是处理任何新变化时要做的第一件事。新的分支将遵循这一模式。

[fix|feature|chore]/[author]-[ticket-number]-[short-humanized-description]

比如说。

  • fix/mario-TKT_3333-world-is-falling-apart
  • chore/mario-TKT_2222-fix-typo
  • feature/mario-TKT_1111-crud-v2-implementation

这样给分支命名有以下三个好处。

人性化的名字更容易理解

分支名称中包含票据类型总是很有用的,因为很明显,你可以从一个苦差事和一个修复中分辨出来,当经理或团队领导想看一下正在实施的新修复时,特别有用。

git branch -r | grep "fix/" | wc -l

个性化的名字

如果由于某种原因,一个特别的票据必须被分割,而且没有办法为每个具体的变化创建多个子票据,那么多个开发人员可以在他们自己的个人功能分支上工作,并且仍然引用同一个票据号。

理想情况下,在完美的世界里,没有开发者应该使用同一个票据号,所以像这样的分支不应该发生。

  • fix/mario-TKT_3333-crud-not-working
  • fix/ruby-TKT_3333-missing-fkey

选择性构建

当使用 CI 时,比如 Gitlab-CI、Jenkins 或 Travis。你可以有选择地构建符合某些模式的分支,比方说只构建那些以fixfeature 开头的分支。这样做的目的是为所有其他真正需要 CI 的分支节省一些宝贵的计算时间。

例如,使用Gitlab-CI,你可以定义一个只用于构建这些分支的重码值,Jenkins的Git插件也有类似的功能,Travis也有。