commit 格式
- <type>(<scope>) : <subject>
- <空行>
- <body>
- <空行>
- <footer>
- 复制代码
- type:本次提交的类别,必填
- scope:影响范围,可以不填
- subject:提交的标题,一句话概括提交的内容
- body:详细描述提交的内容,可以不填
- footer:放置写备注啥的,如果是 bug ,可以把bug id放入
Header
Header部分只有一行,包括三个字段:type
(必需)、scope
(可选)和subject
(必需)
type
type
用于说明 commit 的类别,只允许使用下面标识。
- feat:新功能(feature)
- fix:修补bug
- docs:文档(documentation)
- style: 格式(不影响代码运行的变动)
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)
- test:增加测试
- chore:构建过程或辅助工具的变动
- merge:合并分支
- perf:优化相关,比如提升性能、体验
- revert:回滚到上一个版本
- build:构建
如果 type
为 feat
和 fix
,则该 commit 将肯定出现在 Change log 之中。