书写良好的 Git 提交信息

栏目: 编程工具 · 发布时间: 6年前

内容简介：在使用 Git 的过程中，可以发现 Git 是会强制每次提交都要写提交消息（commit message）的，这也算是 Linus 的良好编程习惯的体现。准确恰当的提交信息对于回溯项目开发历程、寻找特定功能的代码片段等等，都很有帮助。真正到了要写提交信息的时候，很多人可能会图省事，使用关键词有两类，一类是动词，表示进行的动作；另一类是名词，可以与业务相关，也可以是动词的名词化形式。下面是一些常见的关键词：

在使用 Git 的过程中，可以发现 Git 是会强制每次提交都要写提交消息（commit message）的，这也算是 Linus 的良好编程习惯的体现。准确恰当的提交信息对于回溯项目开发历程、寻找特定功能的代码片段等等，都很有帮助。

真正到了要写提交信息的时候，很多人可能会图省事，使用 ... ，或者 abc 这养的内容蒙混过去。这可不是什么好习惯。Git 的提交信息应该简明扼要，描述当前提交所做的主要的事情。可以使用一些可以描述所做改动的关键词作为前缀然后书写详细的信息。

关键词有两类，一类是动词，表示进行的动作；另一类是名词，可以与业务相关，也可以是动词的名词化形式。下面是一些常见的关键词：

add ，或 feature ，表示添加新功能
fix ，缺陷修复
hotfix ，紧急的缺陷修复
update ，对已有功能进行更改或优化
remove ，或者 rm 、 delete ，删除部分代码、功能
refactor ，重构了一些代码、功能
workflow ，工作流程更改
chore ，琐碎的修改

# 新增了支持用户上传文件的功能
$ git commit -m 'add: 上传文件功能'

# 修复了一个线上问题
$ git commit -m 'fix: **页面数字取值问题'

# 对某些代码进行了重构
$ git commit -m 'refactor: 重构商品列表页'

此外，对于每个项目，可以用业务相关的名词作为关键词前缀。例如：

# docs 表示这是对文档进行的修改
$ git commit -m 'docs: 更新接口文档'

以上所述就是小编给大家介绍的《书写良好的 Git 提交信息》，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对码农网的支持！

查看所有标签

猜你喜欢:

本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。

码农书籍

乔布斯离开了，马斯克来了

[日]竹内一正 / 干太阳 / 中信出版社 / 2015-11

在电动汽车的创新上，特斯拉抓住了一个群体的独特需求，外形很酷，不烧油，智能化控制。所有的颠覆式创新都不是敲锣打鼓来的，而是隐藏在一片噪声里，马斯克给我们带来的特斯拉虽然不尽完美，但他做产品的思维和执着于未来的勇气，值得学习。埃隆•马斯克创办公司也不是为了赚钱，而是为了拯救人类和地球，电动汽车、太阳能发电、宇宙火箭，不管是哪一项都足以令一个国家付出巨大的代价去研究开发，但埃隆•马斯克却一个人在做这些......一起来看看《乔布斯离开了，马斯克来了》这本书的介绍吧!

码农工具

XML 在线格式化

在线 XML 格式化压缩工具

RGB HSV 转换

RGB HSV 互转工具