简介
在前端工程师的日常开发中，我们经常需要提交代码到 GitHub，并且需要在提交代码的时候写一些良好的提交信息，如何提交规范的 commit message 是开发团队必须要解决的问题之一。为了解决这个问题，我们可以使用 Commitizen来规范我们的提交信息。
@endemolshinegroup/cz-github 是一个基于 Commitizen 的程序包，它可以使用 GitHub 的 API 来获取所有的 issue 和 PR 并自动生成提交信息，帮助我们规范化的编写提交信息。
在本文中，我将指导你如何使用 @endemolshinegroup/cz-github 来规范化的编写提交信息。
安装
我们可以使用下面的命令安装 @endemolshinegroup/cz-github
npm install --save-dev @endemolshinegroup/cz-github
使用
在安装完成之后，我们可以在 package.json 文件中添加如下代码：
"config": {
"commitizen": {
"path": "./node_modules/@endemolshinegroup/cz-github"
}
},
"scripts": {
"commit": "git-cz"
},同时，我们可以使用 npm run commit 命令来代替 git commit 的方式提交代码。此时，我们只需要按照下面的参数规范中的提示操作即可编写规范的提交信息。
参数规范
@endemolshinegroup/cz-github 提供了如下参数规范，使用这些规范可以帮助我们写出规范的提交信息。
类型
用于说明 commit 的类别，只允许使用下面的 7 个标识。
- feat：新功能（feature）
- fix：修补 bug
- docs：文档（documentation）
- style：格式（不影响代码运行的变动）
- refactor：重构（即不是新增功能，也不是修改 bug 的代码变动）
- test：增加测试
- chore：构建过程或辅助工具的变动
主体
是 commit 的简短描述，不超过 50 个字符。
$ git commit -m 'feat: 开发新功能'
具体内容
详细描述 commit 的内容，可使用多行以更清晰地展现更改内容。
$ git commit -m 'feat: 开发新功能\n\n详细信息描述'
GitHub issues和PR
我们可以使用下面的格式来链接 GitHub issues 和 PR。
$ git commit -m 'feat: 新增功能\n\nCloses #123, #345, #1'
在这个例子中，我们使用 "Closes" 关键字来关闭对应的 issues 和 PR，也可以使用 "Fixes" 和 "Resolves" 关键字。
示例代码
最后，让我们来看一下使用 @endemolshinegroup/cz-github 的示例代码。
-- -------------------- ---- ------- -- - ------------- -- ---------------------------- ---------- - -------- --- - ------ ---------- -------- - ------------- --- - -------------- ---------- -------- -- --- - --- ---- - ------ ------- --- ------ - -------- ------ -- -------- ----------- - ----- --- - --- -------- ------ -------- - --- - --- ---- - ------ ------- --- ------ - -------- ------ -- -------- --------- - ------------ -- -- - - -- ------ --- - - --- --- - - --- --- ------
在上面的示例代码中，我们编写了一个名为 unique 的函数，它用于对数组进行去重；同时编写了一个名为sort 的函数用于对数组进行排序。在代码提交之前，我们使用了 @endemolshinegroup/cz-github 来规范我们的提交信息。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f394b20dbf7be33b2566fc9