为什么要写好Commit Message

案情回顾

最近工作中遇到Commit Message都是如下这种类型

0488A69B7BE5479F8C15839F01145529.jpg
C123E8C21104444C964EEA60835ADBE2.jpg

简单的 fix ut,add log, add test, 修复log等,中英文混合,各式各样Message, 这些Message没有分类,没有详细的描述,没有说明改动的范围等信息。

解决方案

下面以在IntelliJ IDEA中怎么使用插件统一提交规范,分享一下我工作中解决的方法。努力推动组内其他同事一起使用起来。

1,Windows IntelliJ IDEA 安装 Git Commit Template插件,重启IDEA。


1.jpg

2,Commit Changes,点击绿色方框。


2.jpg

3,弹出


3.jpg

下面详细介绍一下各个Tag的作用。

Header

Type of change右边有个下拉三角形,可以选择此次提交的类型,默认是
feat - A new feature 新功能
fix - A bug fix 修复bug
docs - Documentation only changes 只改变了文档
style - Changes that do not affect the meaning of the code (white-space,formatting,missing semi-colons, etc) 不影响代码含义的更改(空白、格式、缺少分号等)
refactor - A code change that neither fixes a bug nor adds a feature 既不修复bug也不添加特性的代码更改
perf - A code change that improves performance 改进性能的代码更改
test - Adding missing tests or correcting existing tests 添加缺失的测试或修改现有的测试
build - Changes that affect the build system or external dependencies(example scopes:gulp, broccoli, npm) 影响构建系统或外部依赖项的更改(例如作用域:gulp、broccoli、npm)
ci - Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) 对CI配置文件和脚本的更改(示例范围:Travis、Circle、BrowserStack、SauceLabs)
chore - Other changes that don't modify src or test files 不修改src或测试文件的其他更改
revert - Reverts a previous commit 返回先前的提交

Scope of this change:用于说明commit影响的范围。比如什么模块。
Short description:简短描述,介绍此次变更的主要内容。

Body

Long description:本次变更的详细内容

Footer

Breaking changes: 不兼容的变动。
Closed issues:关闭问题。

分享总结

日常开发中大多数团队由于缺少对于Commit Message的规定,业务驱动,导致在commit的时候,message随便填写,团队中没有统一的格式。可读性低并且难以维护,查日志的时候我无法从历史message中读出有用的信息。规范的Commit Message在团队开发中很重要,但是否一定要强制按照某一种形式也是仁者见仁的事情,好的规范能提高团队工作效率,提高项目的整体质量,也能提高自己的职业素养。

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

推荐阅读更多精彩内容