提交信息生成
类型 + 范围 + 正文 + 破坏性变更
—
标题控制在 50 字符内最易读,超过 72 字符在 git log --oneline 里会被截断。
如何使用本工具
- 先选类型:新功能 feat、修 bug fix,这两个占了日常提交的大半。
- 范围填模块名,比如 auth、api、user,团队里统一了才好按模块过滤历史。
- 描述用动词开头说清做了什么,「支持手机号验证码登录」比「登录相关修改」有用得多。
- 正文一行一条,别写成一段;破坏性变更务必写清影响范围与迁移方式。
常见问题
Q:为什么标题后面不能加句号?
A:Conventional Commits 约定标题是一个短句片段,不带句末标点。git log --oneline 拼起来时句号会显得啰嗦,工具检测到会自动去掉。
Q:feat 和 refactor 怎么区分?
A:看外部行为有没有变化。对外可见的新能力是 feat;行为不变、只改内部结构的才是 refactor。拿不准时问一句:用户或调用方能感知到区别吗?
Q:BREAKING CHANGE 什么时候用?
A:当改动会导致已有调用方必须改代码才能继续用,比如删了接口参数、改了返回结构、升级了不兼容的主版本。这种提交在语义化版本里对应主版本号加一。
Q:一个提交里改了好几件事怎么办?
A:拆成多个提交。一个提交只做一件事,回滚时才能精准回滚,review 时也更好读。实在拆不开就在正文里逐条列清楚。
Q:类型能自己加吗?
A:可以,团队约定优先。常见扩展有 deps(依赖升级)、release(发版)、wip(临时提交)。加之前确认 CI 或 changelog 工具认不认。