语义化提交(Conventional Commit)是一种标准化的提交信息格式,旨在通过规范化的格式提升代码版本管理的可读性和自动化能力。它被广泛应用于 Git 流水线、CI/CD 和代码审查中。

提交信息结构

<类型>(<范围>): <主题>

[正文]

[footer]
  • 类型(必填):表明提交的性质,常见类型包括:

    • feat:新功能
    • fix:修复错误
    • docs:文档修改
    • style:代码格式调整
    • refactor:代码重构
    • test:测试相关变更
    • chore:日常维护任务
    • perf:性能优化
    • ci:持续集成配置
    • types:类型定义(如 TypeScript)
    • scope:作用域限定(如 auth, ui
  • 范围(可选):用于限定提交影响的模块或组件

  • 主题(必填):简明扼要描述提交的核心内容

  • 正文(可选):补充详细说明

  • footer(可选):添加额外信息(如 BREAKING CHANGE, Issue #123

优点

提升可读性
简化自动化流程
增强版本追溯能力
与工具链无缝集成(如 CommitizenConventional Commits

使用场景

  • 个人项目快速记录变更
  • 团队协作统一提交规范
  • 配合 SemVer 生成版本号
  • 自动化生成 CHANGELOG

扩展阅读

如需深入了解,可访问 Conventional Commits 规范文档 或尝试使用 Commitizen 工具 生成规范提交。

Commit_Message_Type
Commit_Message_Format
Commit_Message_Benefits