专栏首页琯琯博客Git 提交规范

Git 提交规范

一直是 ESLint 的忠实用户,深知规范的重要性。然而,在新项目交接中,我被 Git Commit 规范逼疯了。才意识到自己的疏忽,于是便有了一探究竟的想法。

一、为什么需要规范?

无规矩不成方圆,编程也一样。 如果你有一个项目,从始至终都是自己写,那么你想怎么写都可以,没有人可以干预你。可是如果在团队协作中,大家都张扬个性,那么代码将会是一团糟,好好的项目就被糟践了。不管是开发还是日后维护,都将是灾难。 这时候,有人提出了何不统一标准,大家都按照这个标准来。于是 ESLint,JSHint 等代码工具如雨后春笋般涌现,成为了项目构建的必备良品。 Git Commit 规范可能并没有那么夸张,但如果你在版本回退的时候看到一大段糟心的 Commit,恐怕会懊恼不已吧。所以,严格遵守规范,利人利己。

二、具体规则

先来看看公式:

<type>(<scope>): <subject>

2.1 type

用于说明 commit 的类别,只允许使用下面 7 个标识。

1.  feat:新功能(feature)
2.  fix:修补 bug
3.  docs:文档(documentation)
4.  style: 格式(不影响代码运行的变动)
5.  refactor:重构(即不是新增功能,也不是修改 bug 的代码变动)
6.  test:增加测试
7.  chore:构建过程或辅助工具的变动

2.2 scope

用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

2.3 subject

是 commit 目的的简短描述,不超过 50 个字符。

  1. 以动词开头,使用第一人称现在时,比如 change,而不是 changed 或 changes
  2. 第一个字母小写
  3. 结尾不加句号(.)

规范参考自阮一峰老师的文章:Commit message 和 Change log 编写指南

三、异常处理

我们先来看看这个异常提醒:

INVALID COMMIT MSG: does not match "<type>(<scope>): <subject>" !jartto:fix bug

这里之所以报出这个警告,是因为我的提交出现了两个问题: 其一,使用了规范外的关键字; 其二,很细节的问题,jartto:后少了空格。 这时候我才回忆起来,当时提交一直失败,情急之下直接强制提交,所以以后的提交都会抱出这个异常。大致意思就是: 你的之前的 Commit 不合格~你的之前的 Commit 不合格~你的之前的 Commit 不合格 这时候就很烦了,我们只能去将之前的错误修正,那么如何操作呢?

四、如何修改之前的 Commit 信息?

其实并不复杂,我们只需要这样做:

4.1 将当前分支无关的工作状态进行暂存

git stash

4.2 将 HEAD 移动到需要修改的 commit 上

1、git rebase 9633cf0919^ --interactive
3、找到需要修改的 Commit,将首行的 pick 改成 edit
4、开始着手解决你的 bug
5、 git add 将改动文件添加到暂存
6、 git commit –amend 追加改动到提交
7、git rebase –continue 移动 HEAD 回最新的 commit
8、恢复之前的工作状态
9、git stash pop

大功告成,是不是想把整个 Commit 都修改一遍,逃~ 此处参考自:修改 Commit 日志和内容

五、项目中使用

这时候问题又来了,为什么我提交的时候会有警告,这个又是如何做到的呢? 这时候,我们需要一款 Node 插件 validate-commit-msg 来检查项目中 Commit message 是否规范。

5.1 首先,安装插件:

npm install --save-dev validate-commit-msg

5.2 使用方式一,建立 .vcmrc 文件:

{
    "types": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "build", "ci", "chore", "revert"],
    "scope": {

        "required": false,

        "allowed": ["*"],

        "validate": false,

        "multiple": false
    },

    "warnOnFail": false,

    "maxSubjectLength": 100,

    "subjectPattern": ".+",

    "subjectPatternErrorMsg": "subject does not match subject pattern!",

    "helpMessage": "",

    "autoFix": false
} 

5.3 使用方式二:写入 package.json

{
    "config": {
        "validate-commit-msg": {
          /* your config here */
        }
    }
} 

5.4 可是我们如果想自动使用 ghooks 钩子函数呢?

{
    …
    "config": {
        "ghooks": {

          "pre-commit": "gulp lint",

          "commit-msg": "validate-commit-msg",

          "pre-push": "make test",

          "post-merge": "npm install",

          "post-rewrite": "npm install",
          …
        }
    }
    …
} 

在 ghooks 中我们可以做很多事情,当然不只是 validate-commit-msg 哦。 更多细节请参考:validate-commit-msg

六、Commit 规范的作用

  1. 提供更多的信息,方便排查与回退;
  2. 过滤关键字,迅速定位;
  3. 方便生成文档。

七、生成 Change log

正如上文提到的生成文档,如果我们的提交都按照规范的话,那就很简单了。生成的文档包括以下三个部分:

  • New features
  • Bug fixes
  • Breaking changes

每个部分都会罗列相关的 commit ,并且有指向这些 commit 的链接。当然,生成的文档允许手动修改,所以发布前,你还可以添加其他内容。 这里需要使用工具 Conventional Changelog 生成 Change log :

npm install -g conventional-changelog

cd jartto-domo

conventional-changelog -p angular -i CHANGELOG.md -w

为了方便使用,可以将其写入 package.json 的 scripts 字段。

{
    "scripts": {

        "changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"
    }
} 

这样,使用起来就很简单了:

npm run changelog

到这里,我们所有的问题都搞明白了。

八、总结

看完文章,你还会如此放荡不羁吗?你还会随心所欲的编写 Commit 吗?你还会如此 git commit -m “hello jartto” 提交吗? 答案是否定的,因为使用了钩子函数,你没有机会了,否则将是无穷无尽的恢复 Commit。这倒可以养成良好的提交习惯。

(完)

原文链接

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • awesome-css-cn命名习惯和方式参考其他资源原文链接

    CSS 资源列表,内容包括:CSS预处理器、框架、CSS结构、代码风格指南、命名习惯、播客、演讲视频、大网站的 CSS 开发经验等等。 预处理器 更快地编译 C...

    琯琯
  • Yii2 学习笔记之 Session 跨域共享

    琯琯
  • 排序算法-快速排序

    排序算法-快速排序 <?php /** * 快速排序. * * @param array $value 待排序数组 * @param array $...

    琯琯
  • 你可能会忽略的 Git 提交规范

    一直是 ESLint 的忠实用户,深知规范的重要性。然而,在新项目交接中,我被 Git Commit 规范逼疯了。才意识到自己的疏忽,于是便有了一探究竟的想法。

    DevOps时代
  • HDU1106:排序 (重新修正)

    之前发过一篇HDU 1106的题目,但是因为有童鞋说那篇的源码提交后超时,我们的AlphaWA童鞋重新做了一遍,这次是0ms!算是修正之前的问题,非常感谢~

    ACM算法日常
  • 深入解析CSS样式优先级

    作为前端多多少少都会对CSS样式的权重有一定的了解。最常用的方法就是对不同的选择器分配不同的权重比,常见的就是

    踏浪
  • JavaWeb——JQuery之五种选择器的应用及实践案例总结(基本选择器、层级选择器、属性选择器、过滤选择器、表单过滤选择器)

    2)入口函数:(function () {});       注意:window.onload 和(function () 的区别, 前者只能定义一次,定义多次...

    Winter_world
  • Spark Storage ③ - Master 与 Slave 之间的消息传递与时机

    再次重申标题中的 Master 是指 Spark Storage 模块的 Master,是运行在 driver 上的 BlockManager 及其包含的 Bl...

    codingforfun
  • python技术面试题(二十三)

    The brain is like a muscle. When it is in use we feel very good. Understanding i...

    小闫同学啊
  • 免费使用“在线抓娃娃”SDK,APP变现最佳途径

    上星期,我们发布了一篇名为《即构科技推出全球首个一站式在线抓娃娃机解决方案》的文章,吸引了不少朋友对我们娃娃机方案的问询,但是仍有不少朋友高呼不过瘾,这不,小编...

    BestSDK

扫码关注云+社区

领取腾讯云代金券