commitizen和cz-customizable配置git commit message

比特云栖客
• 阅读 11497

起因

团队对提交的commit message格式有约定俗称的要求,但是没有一个统一的规范,导致大家提交的commit message或多或少不太一样。因此,需要一个工具来帮助大家统一commit message的格式,也方便后续的分析和拓展。

commitizen

commitizen 是一个帮助规范commit message的工具。安装后的效果如下图:

commitizen和cz-customizable配置git commit message

安装commitizen
npm install -g commitizen
安装adapter

commitizen根据不同的adapter配置commit message。例如,要使用Angular的commit message格式,可以安装cz-conventional-changelog

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

现在,进入任何git repository, 使用git cz代替git commit提交commit。

cz-customizable

cz-customizablecz-conventional-changelog一样,也是commitizen的adapter,不过支持一定程度上的自定义。

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

接着,在home目录下创建 .cz-config.js 文件,根据node_modules/cz-customizable/cz-config-EXAMPLE.js配置git cz时弹出的message和对应的输入或者选项。

如果想要进一步进行配置,直接修改node_modules/cz-customizable下的questions.jsbuildCommit.js

buildCommit.js中生成最终commit message:
commitizen和cz-customizable配置git commit message

questions.js中message配置部分:
commitizen和cz-customizable配置git commit message

点赞
收藏
评论区
推荐文章
九路 九路
2年前
HTTP中POST提交数据的四种方式详解
HTTP中POST提交数据的四种方式详解首先说一下为什么写这篇文章,以前写客户端的时候,要经常调用后端的接口,一般很多公司的接口,都是统一POST提交方式服务端响应的是JSON格式字符串,方便统一管理,当时对POST不太清楚,开始的时
kenx kenx
4年前
Spring Boot 无侵入式 实现RESTful API接口统一JSON格式返回
前言现在我们做项目基本上中大型项目都是选择前后端分离,前后端分离已经成了一个趋势了,所以总这样·我们就要和前端约定统一的api接口返回json格式,这样我们需要封装一个统一通用全局模版api返回格式,下次再写项目时候直接拿来用就可以了约定JSON格式一般我们和前端约定json格式是这样的json"code":200,"message
Stella981 Stella981
3年前
Eclipse为不同的文件类型设置编码格式和编辑器
不知道大家遇到项目中编码格式不统一的情况没有,哈哈,我们就是,比如java的编码格式是GBK,html等编码是UTF8,这样会导致很多问题,比如提交了一个UTF8的java文件到SVN,会导致后端编译错误。如果是项目建立的时候,大家一定要注意保持编码格式的统一呀,最好用UTF8。我记录一下,怎么在Eclipse中为不同文本设置不同编码格式和编辑器。
Stella981 Stella981
3年前
Git 对象存储结构分析
1\.前言git对象有四种:blob(数据块),tree(目录树),commit(提交),tag(标签)。本文通过一个示例,以blob为例来讨论对象的存储结构。示例采用的git版本为2.17。2\.实践讨论2.1.生成Blob对象文件首先创建一
Wesley13 Wesley13
3年前
GIT 存储格式与运用
GIT存储格式与运用在GIT的实现规范中,存储格式是非常简单而且高效的,一个代码托管平台通常需要基于这些特性实现一非常有意思的功能。在本文中,将介绍基于GIT存储库格式实现的仓库体积限制与大文件检查。存储库的布局正常的GIT存储库布局应当遵循GIT规范GitRepositoryL
Stella981 Stella981
3年前
Git 实战教程
1.Git配置使用Git的第一件事就是设置你的名字和email,这些就是你在提交commit时的签名,每次提交记录里都会包含这些信息。使用gitconfig命令进行配置:​$gitconfigglobaluser.name"ilimhumar"$gitconfigglobal
Wesley13 Wesley13
3年前
Git中代码冲突的解决方式
使用Git管理代码,在进行代码提交的时候,如果出现了冲突该怎么办呢,下面就两种常见的冲突给出了解决方法,希望对大家有所帮助。冲突1:当你commit以后,在执行gitpullrebase的时候出现冲突,请按如下步骤解决:1 找到冲突文件,解决冲突2 执行gitaddxxx(xxx为冲突文件全路径)3 执行git
Wesley13 Wesley13
3年前
MySQL二进制日志系列
MySQL二进制日志系列总结1、binarylog记录的是 已经提交commit的各种DML和DDL语句,类似oracle的redolog(包含onlineredolog和archiveredolog)中已经commit提交的数据statement格式的binlog,最后会有COMMIT; 
Stella981 Stella981
3年前
Git客户端图文详解如何安装配置GitHub操作流程攻略
Git介绍分布式:Git版本控制系统是一个分布式的系统,是用来保存工程源代码历史状态的命令行工具;保存点:Git的保存点可以追踪源码中的文件,并能得到某一个时间点上的整个工程项目额状态;可以在该保存点将多人提交的源码合并,也可以会退到某一个保存点上;Git离线操作性:Git可以离线进行代码提交,因此它称得上是完全的
Stella981 Stella981
3年前
Git commit message和工作流规范
作者:程柳锋目的统一团队Gitcommit日志标准,便于后续代码review,版本发布以及日志自动化生成等等。统一团队的Git工作流,包括分支使用、tag规范、issue等Gitcommit日志参考案例angular(https://www.oschina.net/action/GoToL
Stella981 Stella981
3年前
Git提交规范流程和解决冲突实际使用
前言:GIT对于我们程序员来说是吃饭的工具,本篇主要是针对提交和分支以及对于大多数程序员闻风丧胆的冲突一些个人见解,如果有啥不对的或者你们公司git提交流程欢迎下方评论。在讨论规范之前,我们需要定最基本的要求1.团队内保持良好的代码格式便于易读和维护,最主要减少不必要的代码冲突(建议统一使用开发工具(idea)的代码格式化)。2.提交任何代码必须