Commit message 的格式
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
其中,Header 是必需的,Body 和 Footer 可以省略。
Header
type(必需)
feat:新功能(feature)
fix:修补bug
docs:文档(documentation)
style: 格式(不影响代码运行的变动)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
test:增加测试
chore:构建过程或辅助工具的变动
scope(可选)
commit 影响的范围,比如host层、conntrol层、视图层等等,具体情况不同而不同。
subject(必需)
commit 目的的简短描述,不要太长,控制在一行可以显示。
Body
可以对commit 的详细描述,可以分成多行。对subject进行补充。
主要:
- 使用第一人称现在时。
- 可以说明代码变动的动机,以及与以前行为的对比。
- 特殊的变动
如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法。 - 关闭问题 Issue
果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。
Closes #123, #456, #789
Revert
特殊情况,如果当前 commit 用于撤销以前的 commit。
安装教程
安装npm
https://nodejs.org/en/
选择下面任何一个,都可以。
安装Commitizen
然后,在项目目录里,运行下面的命令,使其支持 Angular 的 Commit message 格式。
$ commitizen init cz-conventional-changelog --save --save-exact
```
以后,用到git commit命令,都可以改为使用git cz。这时,就会出现选项,用来生成符合格式的 Commit message。