前言:创建新分支时,对 Git 分支进行合理的命名非常重要,应选择有描述性的名称,因为它可以帮助团队成员更好地理解分支的目的和内容,以便将来回顾时能立即明白分支的目的。以下是一些常见的分支命名约定:
-
功能分支:
- 通常以
feature/
或feat/
为前缀,后跟简短的描述性名称。例如:feature/add-user-login
、feat/shopping-cart
。
- 通常以
-
修复分支:
- 对于修复bug的分支,可以使用
fix/
或bugfix/
作为前缀。例如:fix/login-issue
、bugfix/payment-processor
。
- 对于修复bug的分支,可以使用
-
史诗分支(大型功能):
- 对于大型功能或史诗(Epic),可以使用
epic/
作为前缀。例如:epic/customer-onboarding
。
- 对于大型功能或史诗(Epic),可以使用
-
发布分支:
- 发布分支通常用于准备发布,可以命名为
release/
加上版本号。例如:release/1.2.0
。
- 发布分支通常用于准备发布,可以命名为
-
热修复分支:
- 紧急修复可以命名为
hotfix/
或fix/
加上版本号。例如:hotfix/1.1.1
。
- 紧急修复可以命名为
-
实验性分支:
- 对于实验性或探索性的工作,可以使用
exp/
或experiment/
作为前缀。例如:exp/new-algorithm
。
- 对于实验性或探索性的工作,可以使用
-
重构分支:
- 重构代码的分支可以命名为
refactor/
或ref/
。例如:refactor/codebase
。
- 重构代码的分支可以命名为
-
文档分支:
- 文档更新的分支可以命名为
docs/
。例如:docs/update-README
。
- 文档更新的分支可以命名为
-
依赖更新分支:
- 更新项目依赖的分支可以命名为
deps/
或dependency/
。例如:deps/update-npm-packages
。
- 更新项目依赖的分支可以命名为
-
测试分支:
- 用于添加或修改测试的分支可以命名为
test/
。例如:test/end-to-end
。
- 用于添加或修改测试的分支可以命名为
-
用户故事分支:
- 根据敏捷开发中的用户故事命名,可以使用
story/
加上故事编号。例如:story/US123
。
- 根据敏捷开发中的用户故事命名,可以使用
-
主题分支:
- 对于特定主题或功能的分支,可以使用
topic/
。例如:topic/performance-optimization
。
- 对于特定主题或功能的分支,可以使用
创建新分支的命令如下:
git checkout -b [branch-name]
替换[branch-name]为你的分支名称。例如,如果你正在开发一个登录功能,你可以这样做:
git checkout -b feature/add-login