Git 的约定式提交(Conventional Commits)是一种规范化的提交消息格式,用于提供更清晰、更易读的版本控制历史记录。它定义了一套标准的提交消息格式,使得团队成员可以更容易地理解和跟踪代码变更。
约定式提交的格式如下:
<类型>(可选的作用域): <描述>
[可选的正文]
[可选的脚注]
其中,各个部分的含义如下:
-
<类型>
:表示本次提交的类型,常见的类型包括:feat
:新功能(feature)fix
:修复Bugdocs
:文档相关的修改style
:代码格式、样式调整refactor
:重构代码test
:添加或修改测试代码chore
:构建过程或辅助工具的变动
-
(可选的作用域)
:表示本次提交所涉及的模块或组件。可以根据实际情况选择是否使用。 -
<描述>
:简洁明了地描述本次提交的目的。 -
[可选的正文]
:可选项,用于提供更详细的说明和上下文。 -
[可选的脚注]
:可选项,用于包含与提交相关的其他信息,比如关联的 Issue 编号。
以下是一些示例提交消息:
feat: 添加用户注册功能
fix(auth): 修复身份验证逻辑错误
docs: 更新项目文档
通过遵循约定式提交的规范,可以提高团队成员之间的协作效率,更好地管理和维护代码库。同时,还可以结合自动化工具,例如使用 Commitizen 或者 Git 提交钩子,在提交时进行格式检查和验证。