首页/开发/Git 与协作速查/Conventional Commits 提交规范
协作与代码评审75 条

Conventional Commits 提交规范

给提交信息定结构:<type>[scope]: <description>,正文与页脚用空行分隔;让变更可被工具解析,用于自动生成变更日志与版本号。

Git 与协作速查开发更新于 2026-10-12
规范版本Conventional Commits 1.0.0
结构<type>[可选 scope]: <描述> + 可选正文 + 可选页脚
关联与 SemVer 语义化版本配套使用

示例提交

示例提交
git commit -m 'feat(login): 支持邮箱验证码登录'
git commit -m 'fix(api): 修复分页参数溢出'
git commit -m 'feat!: 移除 v1 回调接口'
规范只硬性要求 feat、fix 两类前缀与 BREAKING CHANGE 页脚;其余 type 由团队或工具约定(见类型表条目)。

易错点

  • 团队只约定前缀却不校验时很快会退化,建议在提交钩子或 CI 里加解析检查
  • 描述写成中文没问题,但 type 与冒号格式要与工具保持一致,缺空格可能导致解析失败

数据来源与参考

  • Conventional Commits 1.0.0 规范(conventionalcommits.org)
  • Git 官方文档:git-commit
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌