git是如今市面上最流行的版本控制工具，书写良好的commit message能大大提升代码维护的效率。可是在平常开发中因为缺乏对于commit message的约束，致使填写内容随意、质量良莠不齐，可读性低亦难以维护。在项目中引入commit message规范已经是迫在眉睫。node
1、市场主流规范
如今市面上比较流行的方案是约定式提交规范（Conventional Commits），它受到了Angular提交准则的启发，并在很大程度上以其为依据。约定式提交规范是一种基于提交消息的轻量级约定。它提供了一组用于建立清晰的提交历史的简单规则；这使得编写基于规范的自动化工具变得更容易。这个约定与SemVer相吻合，在提交信息中描述新特性、bug 修复和破坏性变动。它的 message 格式以下:git
2、git commit 规范化工具 —— commitizen
1. 全局安装commitizen & cz-conventional-changelog
commitizen是一个撰写合格commit message的工具，用于代替git commit 指令，而cz-conventional-changelog适配器提供conventional-changelog标准（约定式提交标准）。基于不一样需求，也可使用不一样适配器。工具
安装完毕后，可直接使用git cz来取代git commit。
全局模式下，须要 ~/.czrc 配置文件, 为commitizen指定Adapter。 gitlab
2. 项目内安装commitlint & husky
commitlint负责用于对commit message进行格式校验，husky负责提供更易用的git hook。ui
commitlint只能作格式规范，没法触及内容。对于内容质量的把控只能靠咱们本身。 spa
3. 添加相应配置
建立commitlint.config.js.net
引入 husky版本控制
4. 使用
执行git cz进入interactive模式，根据提示依次填写blog
生成的commit message格式以下：接口
填写完毕后，husky会调用commitlint对message进行格式校验，默认规定type及subject为必填项。
任何git commit指令的option都能用在 git cz指令上, 例如git cz -a
3、Commit message规范在rrd-fe落地使用
1. type
type为必填项，用于指定commit的类型，约定了feat、fix两个主要type，以及docs、style、build、refactor、revert五个特殊type，其他type暂不使用。
当一次改动包括主要type与特殊type时，统一采用主要type。
2. scope
scope也为必填项，用于描述改动的范围，格式为项目名/模块名，例如：node-pc/commonrrd-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。参考文档： User Docs | GitLab
填写方式例如：
4、示例
一、完整的commit message示例
二、相应的git log
5、资料扩展
conventional commits 必读 介绍约定式提交标准。
Angular规范 必读 介绍Angular标准每一个部分该写什么、该怎么写。
@commitlint/config-conventional 必读 介绍commitlint的校验规则config-conventional，以及一些常见passes/fails状况。
--------------------------------------
版权声明：本文为【PythonJsGo】博主的原创文章，转载请附上原文出处连接及本声明。
博主主页：https://my.oschina.net/u/3375733
本篇文章同步在我的公众号：