优化你的Git commit message

简介

无论是写公司的项目或者是自己的项目时,总要向仓库中提交代码。每个人提交代码时写的提交信息都不一样。有随意写各种 modify, fix等简单的,还有一些比较友好,会写上自己此次提交的简介。个人觉得第二种对代码review,或者查找bug引入点时会更有帮助。

简单做个比较如下:

一、


formated.png

二、


not_formated.png

对比之下第一种更加清晰明了。

规范 Commit message

作用

基本上很多团队都有自己的相关规范说明,但是目前使用的比较广泛是 Angular 规范, 基本样式如 上文第一张图所示。

使用依据规范的 Commit message 会有很多好处, 比如:

(1) 提供更多的信息,方便快速浏览。

基于规范的 message 可以直接信息中就包含此次提交的内容。也可以基于 message进行过滤

git log v0.3 HEAD --grep feat

(2) 可以直接根据 commit 生成对应的 Change Log.

Commit message 格式

每次提交 都需要包含三部分:Header,Body 和 Footer。

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

其中 header 是必须的,另外两个可以不写。

  • 标题行: 必填, 描述主要修改类型和内容
  • 主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等
  • 页脚注释: 放 Breaking Changes 或 Closed Issues

其中 标题包括三个字段:type(必需)、scope(可选)和 subject(必需)。

type 有以下一些常见类型:

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动

scope 说明此次变动的范围,一般视具体的项目而定。

subject 是此次提交的简要描述。

工具 Commitizen

如果我们每次手写以上的格式,必定是个痛苦的事情。所以可以使用 Commitizen
这个格式化工具进行撰写.

安装

可以进行全局安装或者基于某项目安装。

全局安装如下:

需要在配置文件中指定 Adapter

npm install -g commitizen cz-conventional-changelog

echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc

当然可能你喜欢的格式与某个项目下要求的格式不一致。可以在某项目下进行配置。

项目内安装:
需要在项目目录下配置 package.json文件。

npm install -D commitizen cz-conventional-changelog

# 以下写入package.json.
"script": {
    ...,
    "commit": "git-cz",
},
 "config": {
    "commitizen": {
      "path": "node_modules/cz-conventional-changelog"
    }
  }

需要提交代码时,执行 git cz -a

效果如下:

    • commitizen.png

自定义

如果需要自行配置相关的 Adapter, 可以使用 cz-customizable 进行自定义。

npm i -g cz-customizable  # 全局
npm i -D cz-customizable  # 项目级

修改对应的配置:

# 全局 .czrc
{ "path": "cz-customizable" }

# 项目级 (package.json)
"config": {
    "commitizen": {
        "path": "node_modules/cz-customizable"
    }
}

推荐一下大佬的配置 leohxj/.cz-config.js

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容