如何做好 Git Commit message 规范化

发表于   |   分类于

如今 Git 在团队开发中使用已经越来越普遍，那么如何做好提交信息的规范化呢？本文主要结合 Angular Git Commit message 规范，来介绍一下相关的配套工具使用。

Commit message 规范化的好处

  • 提供更多的历史信息，方便快速浏览。
  • 可以过滤某些commit（比如文档改动），便于快速查找信息。

如何规范化 Commit message

下面主要介绍一下相关的工具。

Commitizen

commitizen是一个撰写合格 Commit message 的工具。

安装如下：

1
$ npm i -g commitizen

然后，在项目目录里，运行下面的命令，使其支持 Angular 的 Commit message 格式。

1
$ commitizen init cz-conventional-changelog --save --save-exact

以后，凡是用到git commit命令，一律改为使用git cz。这时，就会出现选项，用来生成符合格式的 Commit message。

add-commit.png

  • feat：新增功能；
  • fix：修复bug；
  • docs：修改文档；
  • refactor：代码重构，未新增任何功能和修复任何bug；
  • build：改变构建流程，新增依赖库、工具等（例如- webpack修改）；
  • style：仅仅修改了空格、缩进等，不改变代码逻辑；
  • perf：改善性能的修改；
  • chore：非src和test的修改；
  • test：测试用例的修改；
  • ci：自动化流程配置修改；
  • revert：回滚到上一个版本；

生成 Change log

如果你的所有 Commit 都符合 Angular 格式，那么发布新版本时， Change log 就可以用脚本自动生成
例子
例子

生成的文档包括以下三个部分。

  • New features
  • Bug fixes
  • Breaking changes.

每个部分都会罗列相关的 commit ，并且有指向这些 commit 的链接。当然，生成的文档允许手动修改，所以发布前，你还可以添加其他内容。
conventional-changelog 就是生成 Change log 的工具，运行下面的命令即可。

1
2
3
$ npm install -g conventional-changelog-cli
$ cd my-project
$ conventional-changelog -p angular -i CHANGELOG.md -s

上面命令不会覆盖以前的 Change log，只会在CHANGELOG.md的头部加上自从上次发布以来的变动。

如果你想生成所有发布的 Change log，要改为运行下面的命令:

1
$ conventional-changelog -p angular -i CHANGELOG.md -s -r 0

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

1
2
3
4
5
{
  "scripts": {
    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"
  }
}

以后，直接运行下面的命令即可。

1
$ npm run changelog

原文地址：http://vsoui.com/2018/09/29/git-commit-message/