Git Commit代码提交规范

一、提交规范的核心价值

1.历史追溯
规范提交信息能快速定位问题根源，例如通过 git log --grep fix 筛选修复记录。
2. 自动化支持
工具可基于提交信息自动生成 CHANGELOG、触发构建流程或版本发布。
3. 代码审查效率
清晰描述减少审查者理解成本，加速反馈流程。

二、主流提交规范详解

1. Conventional Commits（约定式提交）

格式：<type>[optional scope]: <description>
示例：feat(login): add social login support
关键组成部分：

• Type（必选）

类型	说明
feat	新增功能
fix	修复 Bug
docs	文档更新
style	代码格式调整（不改变逻辑）
refactor	代码重构
test	测试代码变更
chore	构建工具或依赖调整
perf	性能优化
ci	CI/CD 配置变更
revert	回退历史提交

• Scope（可选）
  用括号注明影响范围，如模块名 user-service 或层级 api/auth。
• Description（必选）
  简明描述变更内容，使用现在时动词开头（如 fix login bug → fix(login): resolve authentication error）。
  扩展用法：
• 破坏性变更：在类型后加 !，如 feat(api)!: remove deprecated endpoint。
• 关联 Issue：在 Footer 中标注 Closes #123 或 Refs #456。

2. Angular 规范（Conventional Commits 的子集）
   专为大型项目设计，强调严格的作用域分类和 BREAKING CHANGE 标识。

2.Angular 规范（Conventional Commits 的子集）

专为大型项目设计，强调严格的作用域分类和 BREAKING CHANGE 标识。

三、工具链集成方案

1. 提交校验工具：commitlint

• 作用：强制提交信息符合规范。
• 配置示例（commitlint.config.js）：

  module.exports = {
    extends: ['@commitlint/config-conventional'],
    rules: {
      'type-enum': [2, 'always', [
        'feat', 'fix', 'docs', 'style', 'refactor', 'test', 'chore', 'perf', 'ci'
      ]],
      'subject-case': [2, 'always', 'lower-case']
    }
  };
  

2. 交互式提交工具：Commitizen

• 作用：通过命令行引导生成规范提交信息。
• 使用流程：
  1. 安装：npm install -g commitizen cz-conventional-changelog
  2. 初始化：commitizen init cz-conventional-changelog --save-dev
  3. 提交：git cz（替代 git commit）

3. Git 钩子工具：husky

• 作用：在提交前自动校验信息。
• 配置示例（package.json）：

  {
    "husky": {
      "hooks": {
        "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
      }
    }
  }
  

四、进阶实践策略

1. 模板化提交
   通过 git config commit.template 设置模板文件，预定义规范格式。
2. 与 Issue 关联
   要求提交信息必须关联 JIRA/GitHub Issue，例如 fix(login): resolve #123 authentication error。
3. 自动生成文档
   使用 conventional-changelog 基于提交记录生成版本更新日志。

五、常见问题处理

• 回退提交：使用 revert: <原提交Hash> 格式，工具会自动关联历史记录。
• 临时调整：允许通过 --no-verify 绕过校验（仅限紧急修复）。
  通过规范提交信息，团队可显著提升代码管理效率。建议结合工具链实现自动化校验，逐步推动规范落地。