参考:阮一峰的网络日志 《Commit message 和 Change log 编写指南》
Commit message 的格式
<type>(<scope>): <subject> ------ Header(必须)
// 空一行
<body> ------ Body(可选)
// 空一行
<footer> ------ Footer(可选)
当使用 git commit -m
命令时,提交的单行commit应写 Header
的内容。
header 规范
Header部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)。
(1)type
用于说明 commit 的类别,只允许使用下面7个标识。
feat
:新功能(feature)fix
:修补bugdocs
:文档(documentation)style
: 格式(不影响代码运行的变动)refactor
:重构(即不是新增功能,也不是修改bug的代码变动)test
:增加测试chore
:构建过程或辅助工具的变动
(2)scope
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
(3)subject
subject是 commit 目的的简短描述,不超过50个字符。
- 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
- 第一个字母小写
- 结尾不加句号(.)
文章评论