Git commit message 规范

内容简介：现在市面上比较流行的方案是安装完毕后，可直接使用

现在市面上比较流行的方案是 约定式提交规范 （ Conventional Commits ），它受到了 Angular提交准则 的启发，并在很大程度上以其为依据。 约定式提交规范 是一种基于提交消息的轻量级约定。它提供了一组用于创建清晰的提交历史的简单规则；这使得编写基于规范的自动化工具变得更容易。这个约定与 SemVer 相吻合，在提交信息中描述新特性、bug 修复和破坏性变更。它的 message 格式如下:

<类型>[可选的作用域]: <描述>

[可选的正文]

[可选的脚注]
复制代码

Quick Start

1. 全局安装commitizen & cz-conventional-changelog

commitizen 是一个撰写合格 commit message 的工具，用于代替 git commit 指令，而 cz-conventional-changelog 适配器提供 conventional-changelog 标准（约定式提交标准）。基于不同需求，也可以使用不同适配器。

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

安装完毕后，可直接使用 git cz 来取代 git commit 。

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

2. 项目内安装commitlint & husky

commitlint 负责用于对 commit message 进行格式校验， husky 负责提供更易用的 git hook 。

Use npm

npm i -D husky @commitlint/config-conventional @commitlint/cli
复制代码

Use yarn

yarn add husky @commitlint/config-conventional @commitlint/cli -D
复制代码

commitlint 只能做格式规范，无法触及内容。对于内容质量的把控只能靠我们自己。

3. 添加相应配置

创建 commitlint.config.js

# In the same path as package.json

echo 'module.exports = {extends: ["@commitlint/config-conventional"]};' > ./commitlint.config.js
复制代码

引入 husky

# package.json

...,
"husky": {
    "hooks": {
      "commit-msg": "commitlint -e $GIT_PARAMS"
    }
}
复制代码

4. 使用

执行 git cz 进入interactive模式，根据提示依次填写

1.Select the type of change that you're committing 选择改动类型 (<type>)

2.What is the scope of this change (e.g. component or file name)? 填写改动范围 (<scope>)

3.Write a short, imperative tense description of the change: 写一个精简的描述 (<subject>)

4.Provide a longer description of the change: (press enter to skip) 对于改动写一段长描述 (<body>)

5.Are there any breaking changes? (y/n) 是破坏性修改吗？默认n (<footer>)

6.Does this change affect any openreve issues? (y/n) 改动修复了哪个问题？默认n (<footer>)
复制代码

生成的commit message格式如下：

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
复制代码

填写完毕后， husky 会调用 commitlint 对message进行格式校验，默认规定 type 及 subject 为必填项。

任何 git commit 指令的 option 都能用在 git cz 指令上, 例如 git cz -a

Commit message规范在rrd-fe落地使用情况

针对团队目前使用的情况，我们讨论后拟定了 commit message 每一部分的填写规则。

1. type

type 为必填项，用于指定commit的类型，约定了 feat 、 fix 两个 主要type ，以及docs、style、build、refactor、revert五个 特殊type ， 其余type 暂不使用。

# 主要type
feat:     增加新功能
fix:      修复bug

# 特殊type
docs:     只改动了文档相关的内容
style:    不影响代码含义的改动，例如去掉空格、改变缩进、增删分号
build:    构造工具的或者外部依赖的改动，例如webpack，npm
refactor: 代码重构时使用
revert:   执行git revert打印的message

# 暂不使用type
test:     添加测试或者修改现有测试
perf:     提高性能的改动
ci:       与CI（持续集成服务）有关的改动
chore:    不修改src或者test的其余修改，例如构建过程或辅助工具的变动
复制代码

当一次改动包括 主要type 与 特殊type 时，统一采用 主要type 。

2. scope

scope 也为必填项，用于描述改动的范围，格式为项目名/模块名，例如： node-pc/common rrd-h5/activity ，而 we-sdk 不需指定模块名。如果一次commit修改多个模块，建议拆分成多次commit，以便更好追踪和维护。

3. body

body 填写详细描述，主要描述 改动之前的情况 及 修改动机 ，对于小的修改不作要求，但是重大需求、更新等必须添加body来作说明。

4. break changes

break changes 指明是否产生了破坏性修改，涉及break changes的改动必须指明该项，类似版本升级、接口参数减少、接口删除、迁移等。

5. affect issues

affect issues 指明是否影响了某个问题。例如我们使用jira时，我们在 commit message 中可以填写其影响的 JIRA_ID ，若要开启该功能需要先打通 jira 与 gitlab 。参考文档： docs.gitlab.com/ee/user/pro…

填写方式例如：

re #JIRA_ID
fix #JIRA_ID
复制代码

示例

完整的commit message示例
相应的git log

扩展阅读

conventional commits 必读 介绍约定式提交标准。

Angular规范 必读 介绍Angular标准每个部分该写什么、该怎么写。

@commitlint/config-conventional 必读 介绍commitlint的校验规则config-conventional，以及一些常见passes/fails情况。

以上就是本文的全部内容，希望本文的内容对大家的学习或者工作能带来一定的帮助，也希望大家多多支持码农网

查看所有标签

猜你喜欢:

本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。

码农书籍

网络是怎样连接的

[日]户根勤 / 周自恒 / 人民邮电出版社 / 2017-1-1 / CNY 49.00

本书以探索之旅的形式，从在浏览器中输入网址开始，一路追踪了到显示出网页内容为止的整个过程，以图配文，讲解了网络的全貌，并重点介绍了实际的网络设备和软件是如何工作的。目的是帮助读者理解网络的本质意义，理解实际的设备和软件，进而熟练运用网络技术。同时，专设了“网络术语其实很简单”专栏，以对话的形式介绍了一些网络术语的词源，颇为生动有趣。本书图文并茂，通俗易懂，非常适合计算机、网络爱好者及相关从......一起来看看《网络是怎样连接的》这本书的介绍吧!

码农工具