Jira Prepare Commit Msg 开源项目最佳实践

1. 项目介绍

jira-prepare-commit-msg 是一个开源项目，旨在帮助开发者在使用 Git 提交代码时自动填充 Jira issue ID 到 commit message 中。这样可以确保每次提交的代码都能够清晰地追踪到对应的 Jira 任务，提高代码管理和项目协作的效率。

2. 项目快速启动

环境准备

• Git
• Node.js

安装步骤

1. 克隆项目到本地：

   git clone https://github.com/bk201-/jira-prepare-commit-msg.git
   cd jira-prepare-commit-msg
   

2. 安装依赖：

   npm install
   

3. 配置项目：

   在项目根目录下创建一个名为 .prepare-commit-msg 的文件，并添加以下内容（根据你的 Jira URL 和项目配置进行调整）：

   const jiraUrl = 'https://your-jira-domain.atlassian.net';
   const jiraProjectKey = 'YOUR_PROJECT_KEY';
   
   module.exports = (commitArgs, commitMessagePath) => {
     // 你的自定义逻辑
   };
   

4. 将 .prepare-commit-msg 脚本添加到 Git hooks：

   在项目的 .git/hooks 目录下创建一个名为 prepare-commit-msg 的文件，并添加以下内容：

   #!/bin/sh
   
   # 调用 Node.js 脚本
   exec node ./path/to/your/.prepare-commit-msg "$1" "$2"
   

   确保 prepare-commit-msg 文件有执行权限：

   chmod +x .git/hooks/prepare-commit-msg
   

3. 应用案例和最佳实践

应用案例

假设你正在处理一个 Jira 任务，ID 为 TASK-123。当你提交代码时，jira-prepare-commit-msg 脚本会自动在你的 commit message 中添加对应的 Jira ID。

最佳实践

• 确保每次提交都包含对应的 Jira issue ID。
• 使用清晰的 commit message 模板，例如：fix(TASK-123): 修复登录功能问题。
• 定期更新 .prepare-commit-msg 脚本以适应项目需求的变化。

4. 典型生态项目

jira-prepare-commit-msg 可以与以下生态项目结合使用，以增强代码管理和协作：

• husky：用于管理 Git hooks 的工具。
• lint-staged：用于在提交代码前对暂存文件进行 lint 检查。
• commitizen：提供标准化的 commit message 格式。