前言
我们在项目开发的过程中，Git 提交记录是非常重要的。它可以体现出我们所做的工作、完成的任务，以及改进的方向等等。而使用 Git 提交时，我们经常需要填写一些提交信息，如 commit message，用来描述本次提交的内容。但在实际开发中，我们经常会发现一些问题：
- 团队成员的提交信息格式不统一，难以理解和阅读；
- 用户故事和 Bug 修复之间可能混淆或漏掉；
- 需要手动填写信息，容易出错，浪费时间。
cz-custom-issues 就是为了解决上述问题而产生的，它是一款基于 commitizen 的 npm 包，用来规范化提交信息的格式，在编写提交信息时提供分类、提醒等辅助功能，从而使团队的 Git 提交信息更加清晰明了，便于管理和回溯。
安装与使用
cz-custom-issues 是一款命令行工具，需要全局安装，可以通过以下命令进行安装：
npm install -g cz-custom-issues
安装完成后，在项目目录下执行以下命令进行初始化：
echo '{ "path": "cz-custom-issues" }' > ~/.czrc然后，我们就可以使用 cz-custom-issues 来提交信息了。执行以下命令：
git cz-custom-issues
此时，会弹出一个交互式的对话框，要求用户填写相关信息：
- Type：表示提交的类型，比如 feature、bugfix、docs 等；
- Scope：表示本次提交的范围，可以填写模块、组件、功能等；
- Subject：是提交信息的主题，应该简明扼要地描述本次提交的内容；
- Body：是提交信息的详细描述，可以包含更多的细节信息；
- Issues：关联本次提交的 Issue 编号，可以是用户故事、Bug 或者其他任务。
这些信息填写完成后，会生成一个标准的 Git 提交信息，比如：
feat(search): add search feature (#123)
其中，feat 表示提交的类型，search 表示本次提交的范畴，add search feature 表示本次提交的主题，#123 则是和本次提交相关的 Issue 编号。
示例代码
为了更好地理解 cz-custom-issues 的使用，我们来看一个简单的示例代码。
-- -------------------- ---- -------
----- ------ - --------------------
-----------------
--------------- -- -
---------------------
--
------------ -- -
-------------------
---我们要对以上代码进行提交，首先执行以下命令：
git cz-custom-issues
然后按照提示进行输入：
- Type：feat
- Scope：search
- Subject：add search function
- Body：Add a new function to search keywords in the database
- Issues：#123
最终生成的提交信息如下：
feat(search): add search function Add a new function to search keywords in the database Closes #123
这样，我们就提交了一份格式规范、内容完整、清晰明了的提交信息，使得提交记录能够更好地被管理和维护。
总结
cz-custom-issues 是一款非常实用的 npm 包，用来辅助管理 Git 提交信息。它提供了一种规范化的提交流程，能够使得团队成员在提交信息时更加清晰明了，从而提高了项目的管理效率。同时，该包还提供了许多自定义的功能，能够满足不同开发团队的需求。希望大家在团队协作开发时，能够认真使用 cz-custom-issues，从而做好有效的提交管理。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600557f181e8991b448d5080