如何在项目中规范git commit格式

天心天地生

已于 2022-04-20 17:24:03 修改

阅读量4.4w

点赞数 2

分类专栏：项目开发文章标签： git

于 2020-08-13 16:12:50 首次发布

本文链接：https://blog.csdn.net/tianxintiandisheng/article/details/107982003

版权

项目开发专栏收录该内容

22 篇文章 0 订阅

订阅专栏

一、为什么要规范化Commit message

格式化的Commit message，有几个好处。

（1）提供更多的历史信息，方便快速浏览。

比如，下面的命令显示上次发布后的变动，每个commit占据一行。你只看行首，就知道某次 commit 的目的。

$ git log <last tag> HEAD --pretty=format:%s

（2）可以过滤某些commit（比如文档改动），便于快速查找信息。

比如，下面的命令仅仅显示本次发布新增加的功能。

$ git log <last release> HEAD --grep feature

（3）可以直接从commit生成Change log。

Change Log 是发布新版本时，用来说明与上一个版本差异的文档，详见后文。

二、Commit message 的格式

每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。

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

其中，Header 是必需的，Body 和 Footer 可以省略。

不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。

2.1 Header

Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。

（1）type

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

feat：新功能（feature）
fix：修补bug
docs：文档（documentation）
style：格式（不影响代码运行的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
test：增加测试
chore：构建过程或辅助工具的变动

如果type为feat和fix，则该 commit 将肯定出现在 Change log 之中。其他情况（docs、chore、style、refactor、test）由你决定，要不要放入 Change log，建议是不要。

（2）scope

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

（3）subject

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

以动词开头，使用第一人称现在时，比如change，而不是changed或changes
第一个字母小写
结尾不加句号（.）

2.2 Body

Body 部分是对本次 commit 的详细描述，可以分成多行。下面是一个范例。

More detailed explanatory text, if necessary.  Wrap it to 
about 72 characters or so. 

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent

注意点:

使用第一人称现在时，比如使用change而不是changed或changes。
应该说明代码变动的动机，以及与以前行为的对比。
如果要编写多行请使用\n 换行回车直接结束描述(注意为反斜杠)

2.3 Footer

Footer 部分只用于两种情况。

（1）不兼容变动

如果当前代码与上一个版本不兼容，则 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.

（2）关闭 Issue

如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue 。

Closes #234

也可以一次关闭多个 issue 。

Closes #123, #245, #992

2.4 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小标题下面。

2.5 git commit 规范格式思维导图

三、如何在项目中规范化Commit message

使用Commitizen替代 git commit

我们的目标还是要通过工具生成和约束, 那么现在就开始吧.

commitizen/cz-cli, 我们需要借助它提供的 git cz 命令替代我们的git commit命令, 帮助我们生成符合规范的 commit message.

除此之外, 我们还需要为 commitizen 指定一个 Adapter 比如: cz-conventional-changelog (一个符合 Angular团队规范的 preset). 使得 commitizen 按照我们指定的规范帮助我们生成 commit message.

全局安装

npm install -g commitizen cz-conventional-changelog
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc

注意:全局模式下, 需要 ~/.czrc 配置文件, 为 commitizen 指定 Adapter.

全局安装后报错

报错信息如下

PS C:\Users\sky\WebstormProjects\Demo\React\umi> echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
PS C:\Users\sky\WebstormProjects\Demo\React\umi> git cz
The config file at "C:\Users\sky\.czrc" contains invalid charset, expect utf8

解决方案
删除根目录下的.czrc,在vscode中新建.czrc文件,文件内容为{ "path": "cz-conventional-changelog" }
在这里插入图片描述

参考资料: github-commitizen-issue [Question] SyntaxError: Parsing JSON at for commitizen config failed

项目级安装

npm install -D commitizen cz-conventional-changelog

package.json中配置:

"script": {
    ...,
    "commit": "git-cz",
},
 "config": {
    "commitizen": {
      "path": "node_modules/cz-conventional-changelog"
    }
  }

如果全局安装过 commitizen, 那么在对应的项目中执行git cz or npm run commit都可以.

效果如下:

使用commitlint校验message

commitlint: 可以帮助我们 lint commit messages, 如果我们提交的不符合指向的规范, 直接拒绝提交, 比较狠.

同样的, 它也需要一份校验的配置, 这里推荐 @commitlint/config-conventional (符合 Angular团队规范).

安装:

npm i -D @commitlint/config-conventional @commitlint/cli

同时需要在项目目录下创建配置文件 .commitlintrc.js, 写入:

module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {},
};

// rule配置说明:：rule由name和配置数组组成，如：'name:[0, 'always', 72]'，
// 数组中第一位为level，可选0,1,2，0为disable，1为warning，2为error，
// 第二位为应用与否，可选always|never，
// 第三位该rule的值
// 参考资料 [commitlint配置](https://juejin.cn/post/6983191125242675230)
// 参考资料 [commitlint官方文档-rule](https://commitlint.js.org/#/reference-rules)

结合 git hooks强制校验

yorkie是Vue作者尤雨溪fork了husky并做了一些修改的工具，改善了一些使用体验，所这里我们介绍一下yorkie。

安装yorkie

npm install yorkie --save-dev

package.json 中添加:

// package.json
{
    "gitHooks": {
       "...": "...",
      "commit-msg": "commitlint -e $GIT_PARAMS",
      "...": "..."
    }
}

使用standard-version生成 Change log

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

standard-version可以做什么?

自动升级版本
自动打tag
自动生成changelog

版本构成

版本号 major.minor.patch

默认的版本更新规则

feature 会更新 minor
bug fix 会更新 patch
BREAKING CHANGES 会更新 major

全局安装

这样做的好处是允许您standard-version在任何 repo/package 上使用，而无需为每个 repo/package 添加 dev 依赖项。

npm i -g standard-version

现在可以使用standard-version 命令替代npm version.

项目级安装

这样做的好处是使您的 repo/package 更便携，因此其他开发人员可以削减版本，而无需standard-version在他们的机器上全局安装。

npm i --save-dev standard-version

将npm run脚本添加到您的package.json

{
  "scripts": {
    "release": "standard-version"
  }
}

现在可以使用 npm run release命令替代npm version`

四、demo项目

天心天地生的demo-doc

以上代码在demo项目里均有体现

五、参考资料

Commit message 和 Change log 编写指南-阮一峰

优雅的提交你的 Git Commit Message-掘金

standard-version官方文档

前端自动化工作流中的hooks

standard-version使用

优化前端工作流：三、使用standard-version管理ChangeLog和Version

天心天地生

关注

2
点赞
踩
3

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录

如何在项目中规范git commit格式

一、为什么要规范化Commit message

二、Commit message 的格式

2.1 Header

2.2 Body

2.3 Footer

2.4 Revert

2.5 git commit 规范格式 思维导图

三、如何在项目中规范化Commit message

使用Commitizen替代 git commit

全局安装

全局安装后报错

项目级安装

使用commitlint校验message

结合 git hooks强制校验

使用standard-version生成 Change log

standard-version可以做什么?

版本构成

默认的版本更新规则

全局安装

项目级安装

四、demo项目

五、参考资料

2.5 git commit 规范格式思维导图