Git Commit Log优雅的提交方式

Git Commit Log优雅的提交方式

本文的完成参考于思否的文章,感谢原作者和阮一峰老师提供的思路。

现在团队开发新项目改用gitlab进行托管,每次进行git commit的时候都很苦恼于写什么信息,于是打算按照前人总结的经验进行规范一下信息。

书写规范

书写规范如下:

<type>: <subject>
<body>
type

提交commit的类型包含以下几种:

  • feat: 新功能
  • fix: 修复问题
  • docs: 修改文档
  • style: 修改代码格式,不影响代码逻辑
  • refactor: 重构代码,理论上不影响现有功能
  • perf: 提升性能
  • test: 增加修改测试用例
  • revert: 回退,建议直接使用Github Desktop回退,而不是使用命令
subject

书写要遵循以下四种规则:格式尽量使用谓宾,使用谓宾不通顺时,可以使用主谓。具体来讲就是新增某某功能、修改某某代码等。

  • 除了名称之外,描述尽可能使用中文,方便不同开发者理解
  • 结尾不加句号
  • 描述控制在20个汉字以内
body

对本地提交的详细描述,不建议。我们建议多次少量提交,而不是一次巨量的提交,有助于revertcode review,也对灾难存储有容灾。

工具

这里的工具使用commitizen

首先进行安装,步骤如下:

cd your-project
npm install commitizen --save-dev
commitizen init cz-conventional-changelog --save --save-exact

等你的项目有改动之后:

git add . //注意后面加上.
git cz

你会发现这里的cz替代了commit命令。如果提示Cannot find module '/Users/Chuck/党建积分/node_modules/cz-conventional-changelog'(这里的路径因人而异),这就需要在package.json修改commitizen的路径。等没有任何问题的时候,提交页面会如下所示:

image

通过上下箭头的选择并输入相应的信息后,一路回车即可。下面是成功提交信息的页面:

image

在命令行敲入命令git log就可看到所有的提交信息,从下图可以看到最终提交的信息格式是:style: 这里是输入提交信息的地方

image

通过这样的方式来描写提交信息,清晰明了,也方便以后通过详细的信息定位问题或回滚代码。

总结

总的来看,采用工具进行提交更加规范,也不容易出错。只需要选择好类型并输入信息就可以了。美中不足的地方就是,不能通过命令行对某个文件的修改进行提交,只能将所有的修改统一进行提交(不过也有可能可以,只是我暂时不知道,希望知道的同学告知一下)。

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