Git 分支规范命名
Git 分支规范命名
引文
https://codingsight.com/git-branching-naming-convention-best-practices/ (opens in a new tab)
Git 提供了强大的分支管理能力，但是不使用适当的命名约定会导致混淆并使代码维护团队复杂化
广义上，我们可以将 Git 分支分为两类：常规（Regular） & 临时（ Temporary） 分支
常规分支
这些分支将在您的永久库中可用，他们的命名约定简单明了。
-
开发（dev）是主要的开发分支。 dev 分支的想法是在其中进行更改，并限制开发人员直接在 master 分支中进行任何更改。 dev 分支中的更改经过审查，并在测试后与 master 分支合并。
-
Master（master）是 Git 存储库中可用的默认分支。 它应该一直很稳定，不允许任何直接签入。 您只能在代码审查后合并它。 所有团队成员都有责任保持 master 稳定和最新。
-
质量保证（QA），或测试分支，包含所有实施的变更的质量保证测试和自动化测试的所有代码。 在对生产环境进行任何更改之前，它必须经过 QA 测试以获得稳定的代码库。
临时分支
顾名思义，这些是可以在需要时创建和删除的分支。 它们可以如下所示：
- Bug Fix
- Hot Fix
- Feature Branches
- Experimental Branches
- WIP branches
专家推荐的临时分支有很多格式和命名约定。这是 Git 分支的简单工作流程
Git 分支命名约定
1. 分支名称以组词开头
组词可以是任何与您的工作流程相匹配的词。
类似下面的简写
-
Bug – 需要尽快修复的错误
-
WIP – 工作正在进行中，我知道它不会很快完成
通过查看分支名称，您可以了解这个 Git 分支是关于什么的以及它的用途
看看下面的例子
- bug-logo-alignment-issue – 开发人员正在尝试修复徽标对齐问题；
- wip-ioc-container-added – 该分支与添加正在进行的 IoC 容器的任务相关
2. 在分支命中使用唯一ID
您可以在分支名称中使用问题跟踪器 ID。 当我修复一些错误时，我更喜欢这种方法。 例如：
wip-8712-add-testing-module
从名称可以看出该分支适用于添加测试模块的任务，issue的追踪 Id为8712，正在进行中。
在分支名称中使用外部跟踪 ID 的另一个优势是可以从外部系统跟踪进度
3. 使用连字符 “-” 或 斜杠 “/” 作为分隔符
许多开发人员使用斜杠作为分隔符，许多开发人员使用连字符。使用哪一个——取决于您和您团队的偏好。
我的意见是连字符使名称更容易阅读，因此它是分支名称中的合适分隔符。
您可以使用斜杠、连字符和下划线。关键是要保持一致。
在分支名称中使用分隔符有两个主要优点：
- 它增加了
可读性并有助于避免混淆； - 它使
管理更容易，尤其是当您处理许多分支机构时。
示例 1. 没有任何分隔符的 Git 分支名称：
featureupgradejqueryversionloginmodule
示例 2. 通过添加分隔符（在本例中为下划线），使 Git 分支名称可读：
feature_upgrade_jquery_version_login_module
4. 在分支名中带上作者名
Many companies prefer to add authors’ names into the branch names according to the format below:
<author>_<branch-type>_<branch-name>E.g., rajeev.bera_feature_new-experimental-changes
This method allows for easy tracking of different developers’ work and progress with additional systems.
5. 避免只有数字的分支名
一些开发者只在分支名称中使用问题Id，这对工作进度没有帮助。
例如，有一个分支名称 9912 - 这个数字能告诉我们什么？这只意味着更多的混乱和出错的风险，尤其是在与其他 git 分支合并时。 (opens in a new tab)
6. 避免混合使用命名约定
混合和匹配所有 Git 分支命名约定不是最佳实践。它只会增加混乱并使整个过程复杂化。
团队应该一次性决定在工作中使用的命名约定，并坚持使用。一致性是最关键的。
7. 避免为长期存在的分支使用冗长的描述性名称
分支名称的基本质量是它应该 准确且信息丰富。让我们再看一些例子：
wip_login_module_which_will_used_in_the_public_website
wip_login_module_which_will_used_in_the_internal_website
在那里，分支名称又长又详细。没有必要。相反，您可以使用以下变体：
wip_feature_login_module
这个名字很短，但它说明了这个分支的用途
小结
Git 分支模型很强大，但你需要正确有效地管理分支。
必要因素之一是 所有团队都遵循相同的约定 ，尤其是本地存储库 (opens in a new tab)的命名约定。
为确保您的团队使用商定的惯例，请执行标准。
最简单的方法之一是使用 Git hooks，比如 pre-commit hook。
我希望上述内容有所帮助
2026 © Lizhenyui.