拜托！别瞎提交代码了，看人家 Git 提交规范那叫一个舒服！

时间 2021-05-21

标签前端 node webpack git web npm json ide 工具 gitlab 栏目 Git 繁體版

原文原文链接

git是如今市面上最流行的版本控制工具，书写良好的commit message能大大提升代码维护的效率。可是在平常开发中因为缺乏对于commit message的约束，致使填写内容随意、质量良莠不齐，可读性低亦难以维护。在项目中引入commit message规范已经是迫在眉睫。前端

用什么规范？

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

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

[可选的正文]

[可选的脚注]

Quick Start

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

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

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

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

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

2.项目内安装commitlint & husky

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

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

Use yarn
yarn add husky @commitlint/config-conventional @commitlint/cli -D

commitlint只能作格式规范，没法触及内容。对于内容质量的把控只能靠咱们本身。json

3. 添加相应配置

建立commitlint.config.jside

# 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格式以下：gitlab

<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

若是你喜欢这篇文章，但愿能动动小手点个在看与转发支持一波。

人人贷大前端技术中心
juejin.im/post/5d0b3f8c6fb9a07ec07fc5d0