在开发过程中,我们经常需要使用 version control system 来管理我们的代码。版本控制工具能较好的协调开发团队的代码管理,其中最为重要的部分就是 commit message。
许多初学者随意书写 commit message,这给代码管理和代码追溯带来了很大的困难。于是,我们引入了 Conventional Commits 规范,它能规范化我们的 commit message,提高了代码管理和追溯效率。
cz-crm 就是一个符合该规范的 npm 包,它使得我们可以快速地创建 commit message,为我们的代码管理提供了很大的帮助。下面我们将介绍 cz-crm 的使用方法。
安装
使用 npm 命令安装 cz-crm:
npm install -g cz-crm
配置
- 在项目根目录下创建
.czrc
文件。 - 编辑
.czrc
文件,添加以下配置:
{ "path": "cz-crm" }
至此,我们已经完成了配置工作。
使用
在提交代码时,使用 commit 命令并输入以下命令:
npm run commit
然后按照提示,填写 commit message,就可以提交代码了。
相比于手动书写 commit message,使用 cz-crm 可以让我们快速、规范地创建 commit message,从而提高我们的代码管理效率。
示例代码
下面是一个示例代码:
-- -------------------- ---- ------- -- -- --- ------- -- ------ -- -- -- ----- -- -- ------ - ------- -------- - -- -- -- ---- --- --- ------
总结
cz-crm 提供了一种规范、标准化的 commit message 方式,可以使得我们的代码管理更加高效、以及可追溯。如果你希望增加 commit message 的可读性和统一性,cz-crm 应该是你的首选 npm 包。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055bbe81e8991b448d956d