Git commit message规范_.gitmessage.txt-程序员宅基地

Git commit message规范

文章目录

- Git commit message规范

一.背景

Git 每次提交代码都需要写commit message，否则就不允许提交。一般来说，commit message应该清晰明了，说明本次提交的目的，具体做了什么操作。但是在日常开发中，大家的commit message千奇百怪，中英文混合使用、fix bug等各种笼统的message司空见怪，这就导致后续代码维护成本特别大，有时自己都不知道自己的fix bug修改的是什么问题。基于以上这些问题，我们希望通过某种方式能够规范用户的git commit message，让规范更好的服务于质量，提高大家的研发效率。

目前，commit message没有标准的规范，Angular团队的规范是社区比较流行的规范，下面要介绍的也是该规范。

二.Angular团队的规范

它的message格式如下：

<type>(<scope>): <subject>
# 空一行
<body>
# 空一行
<footer>

分别对应Commit message的三个部分：Header，Body，Footer。

2.1 Header

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

2.2 Body

对本次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：应该说明代码变动的动机，以及与以前行为的对比。

2.3 Footer

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 提交信息模板

使用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模板信息，在使用起来还是比较麻烦。但是不用担心，我们可以通过扩展来简化该过程。

4.1 git commit template

使用IDEA的话可以下载该插件，此处没有亲自使用过，就不具体介绍了，感兴趣的可以自己尝试。

4.2 git-commit-plugin

使用vscode作为开发工具的话可以下载使用该插件。下面是使用中的一些截图：

按照要求填写好每项内容后，会自动生成commit message，然后点击提交就可以了。

4.3 commitizen

如果是使用终端的话可以使用commitizen。它是一款可以交互式建立提交信息的工具，帮助我们一步步建立提交信息。这里也不详细介绍了，感兴趣的自己去尝试。

五.格式验证

如果是团队开发，对格式要求很严格的话，可以使用commitlint来进行格式验证。

commitlint是一个提交验证工具。原理是可以在实际的git commit提交到远程仓库之前使用git钩子来验证信息。提交不符合规则的信息将会被阻止提交到远程仓库。

六.总结

编码规范、流程规范在软件开发过程中是至关重要的，它可以使我们在开发过程中少走很多弯路。Git commit规范也是如此，确实也是很有必要的，几乎不花费额外精力和时间，但在之后查找问题的效率却很高。作为一名程序员，我们更应注重代码和流程的规范性，永远不要在质量上将就。

参考链接

本文链接：https://blog.csdn.net/qq_44797987/article/details/108263594

原作者删帖不实内容删帖广告或垃圾文章投诉

智能推荐

oracle 12c 集群安装后的检查_12c查看crs状态-程序员宅基地

文章浏览阅读1.6k次。安装配置gi、安装数据库软件、dbca建库见下：http://blog.csdn.net/kadwf123/article/details/784299611、检查集群节点及状态：[root@rac2 ~]# olsnodes -srac1 Activerac2 Activerac3 Activerac4 Active[root@rac2 ~]_12c查看crs状态

解决jupyter notebook无法找到虚拟环境的问题_jupyter没有pytorch环境-程序员宅基地

文章浏览阅读1.3w次，点赞45次，收藏99次。我个人用的是anaconda3的一个python集成环境，自带jupyter notebook，但在我打开jupyter notebook界面后，却找不到对应的虚拟环境，原来是jupyter notebook只是通用于下载anaconda时自带的环境，其他环境要想使用必须手动下载一些库：1.首先进入到自己创建的虚拟环境(pytorch是虚拟环境的名字)activate pytorch2.在该环境下下载这个库conda install ipykernelconda install nb__jupyter没有pytorch环境

国内安装scoop的保姆教程_scoop-cn-程序员宅基地

文章浏览阅读5.2k次，点赞19次，收藏28次。选择scoop纯属意外，也是无奈，因为电脑用户被锁了管理员权限，所有exe安装程序都无法安装，只可以用绿色软件，最后被我发现scoop，省去了到处下载XXX绿色版的烦恼，当然scoop里需要管理员权限的软件也跟我无缘了（譬如everything）。推荐添加dorado这个bucket镜像，里面很多中文软件，但是部分国外的软件下载地址在github，可能无法下载。以上两个是官方bucket的国内镜像，所有软件建议优先从这里下载。上面可以看到很多bucket以及软件数。如果官网登陆不了可以试一下以下方式。_scoop-cn

Element ui colorpicker在Vue中的使用_vue el-color-picker-程序员宅基地

文章浏览阅读4.5k次，点赞2次，收藏3次。首先要有一个color-picker组件 <el-color-picker v-model="headcolor"></el-color-picker>在data里面data() { return {headcolor: ’ #278add ’ //这里可以选择一个默认的颜色} }然后在你想要改变颜色的地方用v-bind绑定就好了，例如：这里的:sty..._vue el-color-picker

迅为iTOP-4412精英版之烧写内核移植后的镜像_exynos 4412 刷机-程序员宅基地

文章浏览阅读640次。基于芯片日益增长的问题，所以内核开发者们引入了新的方法，就是在内核中只保留函数，而数据则不包含，由用户（应用程序员）自己把数据按照规定的格式编写，并放在约定的地方，为了不占用过多的内存，还要求数据以根精简的方式编写。boot启动时，传参给内核，告诉内核设备树文件和kernel的位置，内核启动时根据地址去找到设备树文件，再利用专用的编译器去反编译dtb文件，将dtb还原成数据结构，以供驱动的函数去调用。firmware是三星的一个固件的设备信息，因为找不到固件，所以内核启动不成功。_exynos 4412 刷机

Linux系统配置jdk_linux配置jdk-程序员宅基地

文章浏览阅读2w次，点赞24次，收藏42次。Linux系统配置jdkLinux学习教程，Linux入门教程（超详细）_linux配置jdk

随便推点

matlab(4)：特殊符号的输入_matlab微米怎么输入-程序员宅基地

文章浏览阅读3.3k次，点赞5次，收藏19次。xlabel('\delta');ylabel('AUC');具体符号的对照表参照下图：_matlab微米怎么输入

C语言程序设计-文件(打开与关闭、顺序、二进制读写)-程序员宅基地

文章浏览阅读119次。顺序读写指的是按照文件中数据的顺序进行读取或写入。对于文本文件，可以使用fgets、fputs、fscanf、fprintf等函数进行顺序读写。在C语言中，对文件的操作通常涉及文件的打开、读写以及关闭。文件的打开使用fopen函数，而关闭则使用fclose函数。在C语言中，可以使用fread和fwrite函数进行二进制读写。‍ Biaoge 于2024-03-09 23:51发布阅读量：7 ️文章类型：【 C语言程序设计】在C语言中，用于打开文件的函数是____，用于关闭文件的函数是____。

Touchdesigner自学笔记之三_touchdesigner怎么让一个模型跟着鼠标移动-程序员宅基地

文章浏览阅读3.4k次，点赞2次，收藏13次。跟随鼠标移动的粒子以grid（SOP）为partical（SOP）的资源模板，调整后连接【Geo组合+point spirit（MAT)】，在连接【feedback组合】适当调整。影响粒子动态的节点【metaball(SOP)+force(SOP)】添加mouse in（CHOP)鼠标位置到metaball的坐标，实现鼠标影响。..._touchdesigner怎么让一个模型跟着鼠标移动

【附源码】基于java的校园停车场管理系统的设计与实现61m0e9计算机毕设SSM_基于java技术的停车场管理系统实现与设计-程序员宅基地

文章浏览阅读178次。项目运行环境配置：Jdk1.8 + Tomcat7.0 + Mysql + HBuilderX（Webstorm也行）+ Eclispe（IntelliJ IDEA,Eclispe,MyEclispe,Sts都支持）。项目技术：Springboot + mybatis + Maven +mysql5.7或8.0+html+css+js等等组成，B/S模式 + Maven管理等等。环境需要1.运行环境：最好是java jdk 1.8，我们在这个平台上运行的。其他版本理论上也可以。_基于java技术的停车场管理系统实现与设计

Android系统播放器MediaPlayer源码分析_android多媒体播放源码分析时序图-程序员宅基地

文章浏览阅读3.5k次。前言对于MediaPlayer播放器的源码分析内容相对来说比较多，会从Java-&amp;gt;Jni-&amp;gt;C/C++慢慢分析，后面会慢慢更新。另外，博客只作为自己学习记录的一种方式，对于其他的不过多的评论。MediaPlayerDemopublic class MainActivity extends AppCompatActivity implements SurfaceHolder.Cal..._android多媒体播放源码分析时序图

java 数据结构与算法 ——快速排序法-程序员宅基地

文章浏览阅读2.4k次，点赞41次，收藏13次。java 数据结构与算法 ——快速排序法_快速排序法