介绍
commit-closes 是一个可以自动将 Git 提交和 Issue 关联起来的 npm 包。使用该包，可以避免手动在 Issue 页面中添加 closes #XXX 或 fixes #XXX 标记来关闭 Issue。
安装
npm install -g commit-closes
使用方法
步骤一：安装 commit-closes
首先需要全局安装 commit-closes：
npm install -g commit-closes
步骤二：配置 Git 仓库
在你的项目根目录下运行以下命令来配置 Git 仓库：
git config --local commit.template .gitmessage.txt
该命令会生成一个 .gitmessage.txt 文件，用于设置 Git 提交信息的模板。如果你已经有了自定义的提交信息模板，可以跳过这一步。
步骤三：编写提交信息
在执行 git commit 命令前，需要按照以下格式编写提交信息：
<type>(<scope>): <subject> <body> <footer>
其中 <type> 为提交类型，比如 feat(新功能)、fix(修复) 等；<scope> 表示本次提交影响的范围；<subject> 是本次提交的简要描述；<body> 是本次提交的详细描述；<footer> 用于关联 Issue。
以 fix 类型的提交为例：
fix(login): 修复无法登录的问题 当用户输入错误的密码时，会提示“用户名或密码错误”，实际上应该提示“密码错误”。 closes #123
其中 closes #123 即表示本次提交与 Issue #123 关联。
步骤四：提交代码
完成以上步骤后，可以执行以下命令提交代码：
git commit步骤五：查看关联情况
在 GitHub 或 GitLab 等代码托管平台上，可以查看本次提交与哪些 Issue 关联起来了。如果 Issue 已经被关闭，可以看到它们的状态已经变成了“closed”。
示例代码
下面是一个简单的示例，演示如何使用 commit-closes 自动关联 Issue：
feat(user): 添加个人资料页面 添加个人资料页面，包括姓名、头像、职业等信息。 closes #456
在执行 git commit 命令后，代码托管平台会自动将该提交与 Issue #456 关联起来，方便开发者管理和追踪 Issue。
总结
通过使用 commit-closes，我们可以更加高效地管理和解决 Issue，减少手动添加标记的时间和工作量。但是需要注意的是，只有符合格式要求的提交信息才能被正确地解析并与 Issue 关联起来。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/42331
