Conventional Commits

🔀 规范 Git 提交,自动语义发版

规范 Git 提交信息格式,自动生成语义化版本和更新日志,提升团队协作与自动化工具链集成效率。

收藏
23k
安装
8.3k
版本
1.0.1
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

Conventional Commits 是一套标准化的 Git 提交信息规范,强制要求所有 commit 消息遵循特定格式:<type>[optional scope]: <description>。该 skill 提供完整的类型定义(feat/fix/docs/style/refactor/perf/test/build/ci/chore/revert)、作用域规范、正文与页脚编写指南,以及破坏性变更标记方式(! 符号或 BREAKING CHANGE 页脚)。

显著优点

  • 自动化工具链集成:直接驱动 semantic-release、standard-version 等工具自动生成版本号和 CHANGELOG
  • 语义化版本映射:fix→PATCH、feat→MINOR、BREAKING CHANGE→MAJOR,版本策略清晰可追溯
  • 历史可读性提升:结构化格式使提交历史一目了然,大幅降低代码审查和回滚成本
  • 多语言社区广泛采用:被 Angular、Vue、React、Jest 等主流开源项目采纳,生态成熟

潜在局限

  • 学习成本:团队成员需记忆类型定义和格式规则,初期可能产生抵触
  • 灵活性受限:严格格式要求对复杂变更的描述能力有限,需配合 body/footers 补充
  • 工具依赖:完整价值需配合自动化工具实现,裸用规范收益有限
  • 非代码变更标注模糊:chore 类型成为"垃圾桶",容易堆积杂项提交

适合人群

  • 采用语义化版本控制的软件项目团队
  • 需要自动化发布流程的 DevOps 团队
  • 开源项目维护者(尤其 Node.js/JavaScript 生态)
  • 多人协作、代码审查频繁的中大型工程

常规风险

  • 类型误用导致版本号错误发布(如将 breaking change 标为 feat)
  • 作用域命名不一致削弱分类价值
  • 过度依赖自动化可能忽视人工审查的重要性
  • 与未采用该规范的外部贡献者协作时产生摩擦

Conventional Commits 内容

暂无文件树

手动下载zip · 2.4 kB
contentapplication/octet-stream
请选择文件