开发者社区

文档建议反馈控制台

文章/答案/技术大牛

发布

社区首页 >专栏 >约定式提交：让 Git 历史会说话

约定式提交：让 Git 历史会说话

作者头像

星陨1357

发布于 2026-07-13 13:56:45

发布于 2026-07-13 13:56:45

840

举报

概述

这些记录可能在提交当时，你能明白他的含义，但是，在三个月后的你看来，这玩意其实和天书没什么区别。更糟的是，当团队需要排查问题、生成 CHANGELOG、或者做自动化发布时，这种混乱的日志几乎派不上任何用场。

原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。

如有侵权，请联系 cloudcommunity@tencent.com 删除。

原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。

如有侵权，请联系 cloudcommunity@tencent.com 删除。

评论

登录后参与评论

0 条评论

热度

最新

目录

一、为什么你的 Commit Log 像天书

二、规范长什么样
- 1. type（类型）—— 必填
- 2. scope（范围）—— 可选
- 3. description（描述）—— 必填
- 4. body（正文）—— 可选
- 5. footer（脚注）—— 可选

三、用一个项目实战演练
- 项目结构
- 场景 1：初始化项目骨架
- 场景 2：给 API 层加上 JWT 认证
- 场景 3：修复配置解析的边界问题
- 场景 4：重构存储层，不改功能
- 场景 5：前端加了个新页面，纯 UI
- 场景 6：CI 配置调整
- 场景 7：发了个大版本，有不兼容变更

四、它能带来什么好处
- 1. 自动生成 CHANGELOG
- 2. 语义化版本自动推断
- 3. 快速筛选和排查
- 4. 团队协作更顺畅

五、怎么在团队里落地
- 第一步：先手动写，不急着上工具
- 第二步：在 CONTRIBUTING.md 里写清楚约定
- 第三步：加 commitlint 做校验
- 第四步：接入自动化发布

六、一些常见误区

七、写在最后