内容简介:在使用 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 提交信息》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持!
猜你喜欢:- 复杂sql书写方法
- css BEM书写规范
- python turtle 书写新年快乐
- 书写可维护代码的重要性
- WPF 最小的代码使用 DynamicRenderer 书写
- 【新手整理】18种推荐的CSS命名和书写规范
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
企业应用架构模式
Martin Fowler、王怀民、周斌 / 王怀民、周斌 / 机械工业出版社 / 2004-7 / 49.00元
本书作者是当今面向对象软件开发的权威,他在一组专家级合作者的帮助下,将40多种经常出现的解决方案转化成模式,最终写成这本能够应用于任何一种企业应用平台的、关于解决方案的、不可或缺的手册。本书获得了2003年度美国软件开发杂志图书类的生产效率奖和读者选择奖。本书分为两大部分。第一部分是关于如何开发企业应用的简单介绍。第二部分是本书的主体,是关于模式的详细参考手册,每个模式都给出使用方法和实现信息,并一起来看看 《企业应用架构模式》 这本书的介绍吧!