Conventional Commits 是一种标准化的提交信息格式,通过约定的类型和主题来规范 Git 提交记录。它能提升协作效率并自动生成 changelog。

核心规范

  • 类型(Type):必须使用小写字母,如 feat(新功能)、fix(修复问题)、docs(文档更新)
  • 主题(Subject):简明描述变更内容,不超过 50 字
  • 正文(Body)(可选):详细说明实现细节或动机
  • 页脚(Footer)(可选):标注BREAKING CHANGES或ISSUE引用

例如:

feat: 添加用户登录功能
fix: 修复表单提交时的空格问题
docs: 更新README文件

优势

👍 自动化支持:与 conventional-changelog 等工具无缝集成
📦 语义化版本控制:通过提交类型推断语义化版本号
🔗 可追溯性:清晰的提交信息便于问题追踪和代码审查

使用示例

git commit -m "refactor: 优化数据处理逻辑"
git commit -m "chore: 更新依赖包版本"

扩展阅读

想深入了解如何实施?可参考 Conventional Commit 规范详解 了解更多实用技巧 📘

提交规范