commit message 规范

(这段时间做项目发现,多人合作时或者查看自己修改的以前版本,即使描述很清晰,
一天提交很多版本的情况下,也要逐一仔细查看变化,不是很直观)
下面分享下这两天用的Commit message 的格式:

1.对比

before after after
image
image
image

2.前提:

每次本地代码改动提交到远程,需要注明提交说明,否则不允许提交到远程

git commit -m "hello word" // -m: 指定hello word

提交多行信息:

git commit // 跳出文本编辑器,写多行信息

3.commit message 格式

每次提交,包括三个部分: header, body, footer

<type>(<scope>): <subject> // 必须

                <body> // 可省略

                <footer> // 可省略

解释:

type: 提交类别(下面基本会覆盖提交代码所需,建议只出现下面7种类别,多了会更乱)

feat:新功能(feature)
fix:修补bug
docs:文档(documentation)
style: 格式(不影响代码运行的变动)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
test:增加测试
chore:构建过程或辅助工具的变动
scope:影响范围(可不写)
subject:对改变的正常描述,最好以动词开头语(尽量详细,必填)
body:详细描述(个人认为没必要,可不写)
footer:修改不兼容变动以及关闭 Issue时(个人认为没必要,可不写)

4.撰写合格 Commit message 的工具----Commitizen

安装:

npm install -g commitizen

在项目目录里运行

commitizen init cz-conventional-changelog --save --save-exact

END: 以后凡是用git commit命令 就换成 git cz

这样会自动提示以上几个类别

5.建议不必安装Commitizen工具,自己强制写几天就记住这七种类别了,安装校验反而积累


参考文章:
http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html

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

推荐阅读更多精彩内容

  • git 每次提交代码都会有message说明本次commit的目的。 一. commint 介绍 命令 目前,社区...
    EdmundChen阅读 11,148评论 0 5
  • Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。 上面代码的-m参数,就...
    andyJi阅读 2,826评论 0 0
  • 前言 Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。但是,一般来说,c...
    guanguans阅读 126,006评论 1 63
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,569评论 18 139
  • 每一次commit是阶段性的Ending,应记录着这一阶段所完成的事以及关注点,尽可能详细具体。 注:如果可以的话...
    Jisen阅读 8,051评论 2 6