Git 每次提交代码都需要写commit message
,否则就不允许提交。一般来说,commit message
应该清晰明了,说明本次提交的目的,具体做了什么操作。但是在日常开发中,大家的commit message
千奇百怪,中英文混合使用、fix bug
等各种笼统的message
司空见怪,这就导致后续代码维护成本特别大,有时自己都不知道自己的fix bug
修改的是什么问题。基于以上这些问题,我们希望通过某种方式能够规范用户的git commit message
,让规范更好的服务于质量,提高大家的研发效率。
目前,commit message
没有标准的规范,Angular团队的规范
是社区比较流行的规范,下面要介绍的也是该规范。
它的message
格式如下:
<type>(<scope>): <subject>
# 空一行
<body>
# 空一行
<footer>
分别对应Commit message
的三个部分:Header
,Body
,Footer
。
Header
部分只有一行,包括三个字符按:type
(必须)、scope
(可选)和subject
(必须)。
type
:用于说明commit
的类型。只允许使用下面的标识:
feat
:增加新功能(feature
)。
fix
/to
:修复bug
。
fix
:产生diff并自动修复此问题。适合用于一次提交直接修复bug
。to
:产生diff不自动修复此问题。适合用于多次提交,最终修复bug
提交时使用fix
。docs
:仅仅是修改了文档,如readme.md
。
style
:仅仅是对格式进行了修改,如逗号、缩进、空格等等,不改变代码的逻辑。
build
:构造工具或者外部依赖的改动,例如webpack
、npm
。
refactor
:代码重构,没有新增功能或者修复bug
。
revert
:版本回退。
perf
:优化相关,如提升性能、用户体验等等。
test
:测试拥立,包括单元测试、继承测试等。
chore
:改变构建流程,或者新增依赖库、工具等。
merge
:代码合并。
sync
:同步主线或者分支的bug
。
scope
:用于说明commit
影响的范围,比如:数据层、控制层、视图层等,视项目不同而不同。
subject
:用于说明commit
目的的简短描述,不超过50个字符,以动词开头,使用第一人称现在时,结尾不加句号或其他标点符号。
综上所述,一个完整的Header
如下所示:
fix(view): 修复浏览器不兼容的BUG
对本次commit修改内容的具体描述,可以分为多行。如下所示:
# More detailed explanatory text, if necessary. Wrap it to
# about 72 characters or so. This should answer:
# - Why was this change necessary?
# - How does it address the problem?
# - Are there any side effects?
注意1:使用第一人称现在时。
注意2:应该说明代码变动的动机,以及与以前行为的对比。
Footer
是一些备注,通常是不兼容变动或者是关闭Issue
。
不兼容变动
如果当前代码与上一个版本不兼容,则Footer
部分以BREAKING CHANGE
开头,后面是对变动的描述、以及变动理由的迁移方法。
# BREAKING CHANGE: isolate scope bindings definition has changed.
#
# To migrate the code follow the example below:
#
# Before:
#
# scope: {
# myAttr: 'attribute',
# }
#
# After:
#
# scope: {
# myAttr: '@',
# }
#
# The removed `inject` wasn't generaly useful for directives so there
# should be no code using it.
关闭Issue
如果当前commit
针对某个issue
,那么可以在Footer
部分关闭这个issue
。
# Closes #234
也可以一次关闭多个issue
。
# Closes #123, #245, #992
Revert(可忽视)
还有一种特殊情况,如果当前commit
用于撤销以前的commit
,则必须以revert:
开头,后面跟着被撤销commit
的Header
。
# revert: feat(pencil): add 'graphiteWidth' option
#
# This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
Body
部分的格式是固定的,必须写成This reverts commit <hash>.
,其中的hash
是被撤销commit
的SHA
标识符。
如果当前commit
与被撤销的commit
,在同一个发布(release
)里面,那么它们都不会出现在Change log
里面。如果两者在不同的发布,那么当前commit
,会出现在Change log
的Reverts
小标题下面.
使用git config
配置commit
模板,这样可以更加容易的使提交信息遵循格式。
通过以下命令来配置提交信息模板:
git config commit.template [模板文件名] //这个命令只能设置当前分支的提交模板
git config ——global commit.template [模板文件名] //这个命令能设置全局的提交模板,注意global前面是两杠
新建 .gitmessage.txt
(模板文件) 内容可以如下:
# header: <type>(<scope>): <subject>
# - type: feat, fix, docs, style, refactor, test, chore
# - scope: can be empty
# - subject: start with verb (such as 'change'), 50-character line
#
# body: 72-character wrapped. This should answer:
# - Why was this change necessary?
# - How does it address the problem?
# - Are there any side effects?
#
# footer:
# - Include a link to the issue.
# - BREAKING CHANGE
即使是使用Git配置commit模板信息,在使用起来还是比较麻烦。但是不用担心,我们可以通过扩展来简化该过程。
使用IDEA的话可以下载该插件,此处没有亲自使用过,就不具体介绍了,感兴趣的可以自己尝试。
使用vscode作为开发工具的话可以下载使用该插件。下面是使用中的一些截图:
按照要求填写好每项内容后,会自动生成commit message
,然后点击提交就可以了。
如果是使用终端的话可以使用commitizen
。它是一款可以交互式建立提交信息的工具,帮助我们一步步建立提交信息。这里也不详细介绍了,感兴趣的自己去尝试。
如果是团队开发,对格式要求很严格的话,可以使用commitlint
来进行格式验证。
commitlint
是一个提交验证工具。原理是可以在实际的git commit
提交到远程仓库之前使用git
钩子来验证信息。提交不符合规则的信息将会被阻止提交到远程仓库。
编码规范、流程规范在软件开发过程中是至关重要的,它可以使我们在开发过程中少走很多弯路。Git commit
规范也是如此,确实也是很有必要的,几乎不花费额外精力和时间,但在之后查找问题的效率却很高。作为一名程序员,我们更应注重代码和流程的规范性,永远不要在质量上将就。
文章浏览阅读2w次,点赞7次,收藏51次。四个步骤1.创建C++ Win32项目动态库dll 2.在Win32项目动态库中添加 外部依赖项 lib头文件和lib库3.导出C接口4.c#调用c++动态库开始你的表演...①创建一个空白的解决方案,在解决方案中添加 Visual C++ , Win32 项目空白解决方案的创建:添加Visual C++ , Win32 项目这......_c#调用lib
文章浏览阅读4.6k次。苹方字体是苹果系统上的黑体,挺好看的。注重颜值的网站都会使用,例如知乎:font-family: -apple-system, BlinkMacSystemFont, Helvetica Neue, PingFang SC, Microsoft YaHei, Source Han Sans SC, Noto Sans CJK SC, W..._ubuntu pingfang
文章浏览阅读159次。表单表单概述表单标签表单域按钮控件demo表单标签表单标签基本语法结构<form action="处理数据程序的url地址“ method=”get|post“ name="表单名称”></form><!--action,当提交表单时,向何处发送表单中的数据,地址可以是相对地址也可以是绝对地址--><!--method将表单中的数据传送给服务器处理,get方式直接显示在url地址中,数据可以被缓存,且长度有限制;而post方式数据隐藏传输,_html表单的处理程序有那些
文章浏览阅读1.2k次。使用说明:开启Google的登陆二步验证(即Google Authenticator服务)后用户登陆时需要输入额外由手机客户端生成的一次性密码。实现Google Authenticator功能需要服务器端和客户端的支持。服务器端负责密钥的生成、验证一次性密码是否正确。客户端记录密钥后生成一次性密码。下载谷歌验证类库文件放到项目合适位置(我这边放在项目Vender下面)https://github.com/PHPGangsta/GoogleAuthenticatorPHP代码示例://引入谷_php otp 验证器
文章浏览阅读4.3k次,点赞5次,收藏11次。matplotlib.plot画图横坐标混乱及间隔处理_matplotlib更改横轴间距
文章浏览阅读2.2k次。①Storage driver 处理各镜像层及容器层的处理细节,实现了多层数据的堆叠,为用户 提供了多层数据合并后的统一视图②所有 Storage driver 都使用可堆叠图像层和写时复制(CoW)策略③docker info 命令可查看当系统上的 storage driver主要用于测试目的,不建议用于生成环境。_docker 保存容器
文章浏览阅读834次,点赞27次,收藏13次。网络拓扑结构是指计算机网络中各组件(如计算机、服务器、打印机、路由器、交换机等设备)及其连接线路在物理布局或逻辑构型上的排列形式。这种布局不仅描述了设备间的实际物理连接方式,也决定了数据在网络中流动的路径和方式。不同的网络拓扑结构影响着网络的性能、可靠性、可扩展性及管理维护的难易程度。_网络拓扑csdn
文章浏览阅读1.8k次,点赞5次,收藏8次。IOS系统Date的坑要创建一个指定时间的new Date对象时,通常的做法是:new Date("2020-09-21 11:11:00")这行代码在 PC 端和安卓端都是正常的,而在 iOS 端则会提示 Invalid Date 无效日期。在IOS年月日中间的横岗许换成斜杠,也就是new Date("2020/09/21 11:11:00")通常为了兼容IOS的这个坑,需要做一些额外的特殊处理,笔者在开发的时候经常会忘了兼容IOS系统。所以就想试着重写Date函数,一劳永逸,避免每次ne_date.prototype 将所有 ios
文章浏览阅读5.3k次。方法一:用PLSQL Developer工具。 1 在PLSQL Developer的sql window里输入select * from test for update; 2 按F8执行 3 打开锁, 再按一下加号. 鼠标点到第一列的列头,使全列成选中状态,然后粘贴,最后commit提交即可。(前提..._excel导入pl/sql
文章浏览阅读83次。Git常用命令速查手册1、初始化仓库git init2、将文件添加到仓库git add 文件名 # 将工作区的某个文件添加到暂存区 git add -u # 添加所有被tracked文件中被修改或删除的文件信息到暂存区,不处理untracked的文件git add -A # 添加所有被tracked文件中被修改或删除的文件信息到暂存区,包括untracked的文件...
文章浏览阅读202次。分享119个ASP.NET源码总有一个是你想要的_千博二手车源码v2023 build 1120
文章浏览阅读1.8k次。版权声明:转载请注明出处 http://blog.csdn.net/irean_lau。目录(?)[+]1、缺省构造函数。2、缺省拷贝构造函数。3、 缺省析构函数。4、缺省赋值运算符。5、缺省取址运算符。6、 缺省取址运算符 const。[cpp] view plain copy_空类默认产生哪些类成员函数