Git 提交信息规范入门:让每次 commit 都言之有物
Git 提交信息规范入门:让每次 commit 都言之有物
翻开一个协作项目的提交历史,常见的画面是一连串"更新"、“fix”、“修改一下”,几个月后连作者自己都说不清每次改动到底做了什么。提交信息不是写给机器看的,而是写给未来的自己和同事看的。这篇文章介绍一套被广泛采用的提交规范——Conventional Commits,帮你把提交记录变成可读的项目日志。
一、基本格式
一条规范的提交信息由三部分组成:
<类型>(<范围>): <简短描述>
<可选的正文>
<可选的脚注>
其中类型是必填的,用固定单词表达本次改动的性质;范围可选,说明影响到的模块;描述用一句话概括做了什么,动词开头、现在时、不超过 50 个字符。
二、常用类型
feat:新增功能,对应语义化版本里的次版本号。
fix:修复缺陷,对应修订号。
docs:只改文档。
style:不影响逻辑的格式调整,如空格、分号。
refactor:重构,既不修缺陷也不加功能。
perf:性能优化。
test:增补或修正测试。
chore:构建流程、依赖管理等杂项。
例如:
feat(auth): 支持手机号验证码登录
fix(api): 修复分页参数越界导致的 500 错误
docs(readme): 补充本地部署的环境要求
三、为什么值得坚持
第一,自动化工具依赖它。语义化版本号可以由提交类型自动推导,变更日志也能一键生成,省去手工整理。第二,代码评审更高效:评审人扫一眼提交列表就能判断改动性质,优先看 feat 和 fix,把 style 类改动留到最后。第三,出问题时排查更快,git log --oneline 就能给出清晰的改动脉络;配合 git bisect 定位引入缺陷的提交时,规范的描述能大幅缩短排查时间。
四、落地建议
团队引入规范时不必一步到位。先约定类型清单和格式模板,用 commitlint 之类的工具加一道校验即可。对于历史遗留的混乱提交,不必回头重写;从新提交开始执行,几个月后仓库的气质就会明显不同。如果使用 AI 辅助生成提交信息,把规范作为提示的一部分,产出的质量会稳定很多。
总结
好的提交信息三要素:类型明确、描述具体、必要时补充动机与影响。养成习惯后,git log 就不再是负担,而是项目最有价值的文档之一。
(本文为作者原创技术笔记,欢迎交流指正。)
- 点赞
- 收藏
- 关注作者
评论(0)