在日常的前端开发工作中，我们经常会用到 git 进行代码版本管理。而编写清晰、规范的 commit message 则是在团队协作、代码审查等方面非常重要的一部分。
事实上，许多公司在开发开源项目时都会制定自己的 commit message 规范。这种规范可能涉及到一些必须包含的信息项、信息格式等等。因此，我们需要一种能够辅助我们在写 commit message 时遵循规范的工具。
今天，我将向大家介绍一款名为 commit-template 的 npm 包，它可以让我们轻松地创建并遵循指定的 commit message 规范。
安装
想要使用 commit-template，首先需要全局安装它。使用以下命令即可：
npm install -g commit-template
安装完成后，我们就可以开始使用 commit-template 来创建和编辑 commit message 模板了。
创建 commit message 模板
虽然 commit-template 提供了一些通用的 commit message 模板，但我们还是要根据项目的实际需要来创建一个符合规范的模板。
使用以下命令可以创建一个名为 .gitmessage 的 commit message 模板文件：
touch ~/.gitmessage
然后，我们可以使用文本编辑器打开该文件并输入自定义的 commit message 模板，比如：
feat(moduleName): 新增 XXX 功能 为了实现 XXX 功能的需求，在 XXX 业务模块中新增了 XXX 模块。
这里，我们指定了 commit message 模板的头部包含 "feat(moduleName): "，表示此次提交是一个功能新增。
配置 Git 使用 commit message 模板
现在我们已经创建了 commit message 模板文件，接下来需要告诉 Git 使用这个模板文件。
使用以下命令可以指定 Git 使用我们上一步中创建的 .gitmessage 文件作为 commit message 模板：
git config --global commit.template ~/.gitmessage
现在，每次使用 git commit 命令提交代码时，都会默认加载我们之前定义的 commit message 模板。如果你需要编辑 commit message，并且遵循模板的格式进行填写，可以直接在终端执行 git commit 命令即可。
示例代码
以下是一个在 commit-template 帮助下编写的 commit message 的代码示例：
-- -------------------- ---- ------- - --- ------ - --------- - - ----------------- -- --- -- - - ---- --- ------- --- -------- --- --- - - ---------------- - - ----------------------------
结语
commit-template 可以帮助我们遵循规范，减少代码版本管理时可能出现的混乱和错误。它还可以帮助我们在团队协作中更好地交流和沟通。
希望今天的介绍能对大家有所帮助。祝大家使用愉快！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600562dd81e8991b448e04ed