Git提交信息规范

Git对程序员来说是再熟悉不过的了。但是很多程序员其实并没有规范的使用git,最简单的提交信息的内容其实就有很多人不注意。

一、git提交

我们用git提交代码:

git commit -m “hello world” 。

我们现在说的就是”hello world” 怎么书写的规范。

“hello world” 就是我们常说的commit mesage。

上面代码的-m参数,是用来指定 commit mesage 的。

这里推荐使用目前使用最广泛的 angular 规范。

二、规范内容

angular 规范的 commit message 包括 3 个部分 ,header 、body 和 footer 。

<type> (<scope>) : <subject>//空一行<body>//空一行<footer>

type:

type 用于说明 commit 的类型,只允许使用下面 7 个标识

feat: 新功能(feature)

fix: 修补 Bug

docs: 文档 (documention)

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

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

test: 增加测试

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

scope:

scope 用于说明 commit 影响的范围,比如数据层、控制层、视图层等,视项目不同而不同

subject 是 commit 目的的简短描述,不超过 50 个字符

body 部分是对本次 commit 的详细描述,可以分成多行

footer 部分只用于两种情况

不兼容变动时,以 BREAKING CHANGE 开头,后面是对变动的描述以及变动理由和迁移方法

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

例子:

feat: 新增分析师清理功能 分析师清理功能,包括 1. 查询分析师 2. 分时段清理

fix: minor typos in code see the issue for details on the typos fixed fixes issue #12

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注