git 提交时 commit 信息应该怎么写

规范参考

约定式提交 https://www.conventionalcommits.org/zh-hans/

<类型>:  改了什么内容
^----^  ^---------^
|       |
|       +-> 简明扼要的说明本次提交的意图.
|
+-------> 类型范围: chore, docs, feat, fix, refactor, style, or test.

类型说明

类型 说明
feat 用户功能的新特性(项目自身构建方式的更新,不算新特性)
fix 用户功能修复(项目自己的构建错误修复,不算功能修复)
docs 更新文档
style 代码格式化或风格变化
refactor 重构(修改变量名、文件目录结构等不影响功能的变动)
test 增加、修改测试代码,不涉及生产运行代码变化
chore 日常维护,不涉及生产运行代码变化(写错个字、变更个版本号啥的)

如果已提交记录不符合规范,可以使用 git 重写提交记录 的方法进行修改。

优秀案例

看看 git 的发明者:linus 是怎么写提交信息的

简单内容参考

简单的

复杂内容参考

复杂的

有从 Linux+Git 之父身上学到吗?

真实情况

作为一名老程序员,需要讲述真实。以上,都是学术思想的理论规范。实际在写 commit 信息的时候,是很难达到的。因为优秀的提交规范基于这样一个核心假设:

你的 commit 是有意义的。

同时为了补充例外情况,提交规范还默认你有这样的能力:

你可以修改历史提交记录。

然而,项目中这两条都是不允许的。真实的项目以业务为主,大量的冗余、反复、的细节需求更改,导致你的提交中有很多是无意义的。我们常听到这句:还是用刚才那个版本吧。这时候一个 commit 加一个 revert 就是两个提交了。

我们难道不能做好了再提交上去吗?
不能。原因有两个,一个是环境,你做好之后必须通过提交,才能发布到可以测试的环境;另一个是,功能往往是两个人合作(前端+后端模式),两个人要同步代码,此时至少需要一个人提交。

我们难道不能时候通过重写 git 提交记录来优化提交信息吗?
不能。变更 git 历史记录意味着分叉,一旦出大型分叉(100个commit差异,500个文件变化)你怎么跟主干分支合并?merge 或者 rebase?出现冲突的话你能 resolve 吗?很可能冲突的编程语言你都没写过。直接覆盖 master 吗?代码冲突倒是没了,但是你小心接下来会有肢体冲突!

大家都怎么写 commit 信息

真是情况是这样的:

  1. 跟绩效挂钩:认真写,可能提交信息写的比代码变更还多。
  2. git commit 钩子,比如 husky:符合规范的格式(不然不能commit),但内容没有太大意义,反正提交上去就好。
  3. 给大家指导规范,然后自己注意:各种牛鬼蛇神的提交就都上来了,少数符合提交规范的提交,此时也显得没啥用处。

为什么大家都不认真写 commit 信息?
请你自己想一下,你什么时候翻过一年前的提交的 commit 信息?毕竟,你做的又不是开源项目,毕竟看变动记录应该直接翻代码版本,看提交信息作甚?说到底,大部分项目质量不高,在无人观察的角落,谁还会在意自己的举止是否得体。

该怎么写 commit 信息

好习惯是慢慢养成的,从现在开始认真按照规范来写。 -- 高质量项目

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

推荐阅读更多精彩内容