概述
Git 约定式提交(Conventional Commits)是一种用于编写git commit
消息的规范,它通过大家约定俗成的方式,制定了一套标准的commit
提交信息格式,以使得项目的版本控制更加的清晰和一致。采用这种规范的好处是能够帮助开发团队更好的理解代码的变更历史以及生成变更日志(changelog)。
基本格式
<类型>[<范围>]: <描述>
<空行>
[主体]
<空行>
[footer]
-
类型(type):用于说明提交的类型,例如是修复bug还是添加新的功能。常见的类型包括:
feat
:新功能(feature)fix
:修补bugdocs
:文档(documentation) 变更style
:代码格式(没有修改代码内容,仅删除换行、添加换行等)refactore
:重构(既不是新增功能、也不是修复bug)test
:增加了测试chore
:构建过程或辅助工具的变动
-
范围(scope):可选项,用于说明该提交影响的范围(模块、文件等)
-
描述(subject):简要说明提交的内容
-
主体(body):可选项。用于详细说明本次提交的内容,可分成多行
-
脚注(footer):可选项,用于说明重大变更,或者关联 issue。例如:
BREAKING CHANGE
:破坏式更改,说明重大变更Closes #123
:关闭某个 issue
示例
feat(auth): add login functionality
Added login functionality with OAuth2 integration. Users can now log in using their Google account.
Closes #45