Git 中分支和提交命名的简化约定

关于 git 分支和提交，有很多优秀的命名约定。

但是，如果你想要非常精简和简单的命名，该怎么办？

这里有一个建议。

分支命名约定

Git分支命名约定这篇文章是一个很好的基础。
然而，你还可以进一步简化。

类别

Git 分支应该以一个类别开始。请选择以下类别之一：feature、bugfix、hotfix或test。

• feature用于添加、重构或删除功能
• bugfix用于修复错误
• hotfix用于使用临时解决方案和/或不遵循通常流程（通常是由于紧急情况）更改代码
• test用于在问题/票证之外进行实验

参考编号

：类别后应有一个“ /”，后跟您正在处理的问题/工单的参考编号。如果没有参考编号，只需添加no-ref。

描述

引用之后，应该再加一个“ /”，后面跟着一段描述，概括此特定分支的用途。此描述应简短，并使用“短横线分隔符”。

默认情况下，您可以使用您正在处理的问题/工单的标题。只需将任何特殊字符替换为“ -”。

总而言之，分支时请遵循以下模式：

git branch <category/reference/description-in-kebab-case>

例子：

• 您需要添加、重构或删除某个功能：git branch feature/issue-42/create-new-button-component
• 您需要修复一个错误：git branch bugfix/issue-342/button-overlap-form-on-mobile
• 您需要快速修复错误（可能使用临时解决方案）：git branch hotfix/no-ref/registration-form-not-working
• 您需要在问题/票证之外进行实验：git branch test/no-ref/refactor-components-with-atomic-design

提交命名约定

对于提交，您可以合并并简化 Angular提交消息指南和常规提交指南。

类别

提交信息应该以变更类别开头。几乎所有内容都可以使用以下四个类别：feat、fix、refactor和chore。

• feat用于添加新功能
• fix用于修复错误
• refactor用于更改代码以提高性能或方便性（例如可读性）
• chore用于其他一切（编写文档、格式化、添加测试、清理无用代码等）

类别之后应该有一个“ :”来宣布提交描述。

语句：

冒号后，提交描述应由简短的语句组成，用于描述变更。

每个语句应以祈使式动词开头。语句之间应使用“ ”分隔;。

总而言之，提交时请遵循以下模式：

git commit -m '<category: do something; do some other things>'

例子：

• git commit -m 'feat: add new button component; add new button components to templates'
• git commit -m 'fix: add the stop directive to button component to prevent propagation'
• git commit -m 'refactor: rewrite button component in TypeScript'
• git commit -m 'chore: write button documentation'

参考

来源

• 文章：Git 分支名称约定
• 文章：常规提交 1.0.0
• 文章：提交消息指南
• 文章：成功的 Git 分支模型