Git提交信息规范

在项目中使用工具规范Git提交信息格式。

在使用Git进行代码的分布式版本控制时,规范化commit message可以帮助程序猿在多人开发协作中更好的理解他人对代码的改动信息,避免大家按照各自的理解和习惯(甚至是随意)书写,而对他人和自己造成困惑,从而增加代码审查和纠错的时间成本。

本规范基于 Angular 规范,这是目前commit message使用最广的写法,比较合理和系统化,并且有配套的工具。

作用

一个规范化的commit message,具有以下作用:

  • 提供更多的历史信息,方便快速浏览

  • 可以过滤某些commit(比如文档改动),便于快速查找信息

  • 可以直接从commit生成CHANGELOG.md

格式

使用git commit可以提交多行,包括三个部分:

  • Header【必填】

  • Body【选填】

  • Footer【选填】

<type>(<scope>): <subject> <!-- header -->
<!-- 空一行 -->
<body>
<!-- 空一行 -->
<footer>

说明:

任意一行都不应该超过100字符,这样的信息在github和各种各样的git工具上能有更好的可读性。

注意Header 是必填Body 和 Footer 是选填。

Header

Header包括三个字段:

  • type(必填)

  • scope(选填)

  • subject(必填)

<type>(<scope>): <subject>

Type

用于说明commit的类别,只允许使用下面7个标识(featfix包含在CHANGELOG.md中):

  • feat:新功能(feature)

  • fix:修补bug

  • docs:文档(documentation)

  • style:格式(不影响代码运行的变动)

  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)

  • test:增加测试

  • chore:构建过程或辅助工具的变动

Scope

用于说明 commit 影响的范围,比如数据层、控制层、视图层等等

Subject

用于对commit目的的简短描述,不超过50个字符

以动词开头,使用第一人称现在时,比如`change`,而不是`changed`或`changes`第一个字母小写结尾不加句号(.)

# 示例一
fix(login): 修改登录账号加密方式
# 示例二
fix: 去除登录页面console代码

Body

Body部分是对本次commit的详细描述,可以分成多行。下面是一个范例:

更加详细的解释文字,可以添加多行。
- 可使用列表列出详细问题
- 开头为连字符加一个空格
# 示例一
本次修改utils.js中的fetch函数,增加了两个特性:
- 参数showLoading控制请求是否显示加载中
- 参数quite控制请求出错是否使用全局提示

Footer

Footer部分只用于两种情况:

  • 不兼容变动

    如果当前代码与上一个版本不兼容,则Footer部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法。

  • 关闭Issue

    如果当前commit针对某个issue,那么可以在Footer部分关闭这个issue

# 示例一
Closes #123, #456, #789
# 示例二
BREAKING CHANGE: fetch函数将在此次新版中不再支持回调函数,请注意修改相关代码
旧版使用
fetch({
success () {
console.log('success')
},
error () {
console.error('error')
}
})
新版使用
try {
await fetch()
console.log('success')
} catch (err) {
console.error('error')
}

示例

feature示例

# 详细版
feat(login): 新增登录验证和记录机制
针对登录成功失败进行验证,并对问题进行记录,以分析具体用户具体的活动
# 简化版
feat(login): 新增登录验证和记录机制

fix示例

# 详细版
fix(login): 修复了登录失败的问题
因登录接口对数据的接受格式不对,造成部分用户登录登录失败
Closes #9527, #5386
# 简化版
fix(login): 修复了登录失败的问题

refactore示例

# 详细版
refactor: 修改请求代理组件
修改请求代理以减少代码中对baseUrl的依赖,所有的请求地址为直接的API
BREAKING CHANGE
旧版
$get(BASE_URL + '/api/get')
新版
$get('/api/get')
# 简化版
refactor: 修改请求代理组件由$get(BASE_URL + 'api')改为$get('api')

提交工具

信息填写辅助

命令行提交

在命令行中,使用工具 commitizen 来辅助格式化git commit message,它提供了一种问询式的方式去获取所需信息。

安装

$ npm install -g commitizen

使用

# 直接使用执行提交
$ git cz
# OR=================
# package.json 添加配置
{
"script": {
"commit": "npx git-cz"
}
}
# 使用nodejs调用执行
$ npm run commit

参照下面动图:

git-cz使用演示

GUI工具提交

VsCode 编辑器 Extensions 里面搜索 Visual Studio Code Commitizen Support (或点击此链接进行安装)。

使用方式:

  • 打开命令面板 (ctrl+shift+p or command+shift+p) 输入 'conventional commit';

  • 选择此次提交类型 (type, scope, subject, body, breaking changes, closed issues);

  • 然后按步骤填写对应的信息。

提交过程中可以按 [ESC] 键退出此次提交

使用 SourceTree 这款软件提交信息也需要按规范填写。

信息验证

信息验证和代码格式验证一样是强制执行的,错误格式的提交信息是不允许的。

在验证提交信息是否符合规范时这里会用到三个东西:

{
"husky": {
"hooks": {
// 提交信息钩子:执行信息验证。通过则提交成功,不通过则提交失败
"commit-msg": "commitlint -e $GIT_PARAMS"
}
},
"commitlint": {
"extends": [
// 使用angular提交规范
"@commitlint/config-angular"
]
}
}

在执行 git 提交信息时触发 commit-msg 钩子进行信息验证。通过验证正常提交,未通过查看错误信息修改并重新修改

提交错误信息

结果展示

可使用工具conventional-changelog-cli生成此次发版包含的提交内容。

$ conventional-changelog -p angular -i CHANGELOG.md -s
# 将在根目录生成CHANGELOG.md文件