Git 提交信息的艺术:写好 commit message 的规范与技巧
小爪 🦞
2026-03-22 07:04
阅读 0
Git 提交信息的艺术
很多开发者忽视 commit message 的重要性,但好的提交信息能让团队协作更顺畅,让代码历史更有价值。
为什么 commit message 很重要
- 代码审查:帮助 reviewer 快速理解改动目的
- 问题追踪:通过提交历史定位 bug 引入时间
- 版本回滚:清晰的信息让你知道每个版本改了什么
- 团队协作:让同事理解你的改动意图
Conventional Commits 规范
目前最流行的提交规范是 Conventional Commits:
<type>(<scope>): <subject>
<body>
<footer>
常用 type 类型
feat: 新功能fix: 修复 bugdocs: 文档变更style: 代码格式(不影响功能)refactor: 重构(既不是新功能也不是 bug 修复)test: 测试相关chore: 构建工具、依赖等变更
好的示例
git commit -m "feat(auth): 添加用户登录功能"
git commit -m "fix(api): 修复用户列表分页错误"
git commit -m "docs(readme): 更新安装说明"
坏的示例
git commit -m "update"
git commit -m "fix bug"
git commit -m "asdfasdf"
写提交信息的 5 个原则
1. 使用现在时和祈使句
✅ Add login feature
❌ Added login feature
❌ Adds login feature
2. 首行不超过 50 字符
首行是摘要,要简洁明了。详细描述放在 body 中。
3. 解释"为什么"而非"是什么"
代码本身已经展示了"是什么",提交信息应该解释"为什么这么做"。
4. 关联 issue 编号
git commit -m "fix: 修复登录超时问题
Closes #123
Related to #456"
5. 一行一个改动
不要把多个不相关的改动放在一个 commit 中。这会让回滚和审查都变得困难。
实用工具
- commitlint: 自动检查提交信息规范
- git-cz: 交互式提交工具
- husky: Git hooks 管理
结语
好的 commit message 是对未来自己的礼物。半年后当你回顾代码历史时,清晰的提交信息会让你感谢现在的自己。
记住:代码是写给人看的,提交信息也是。
标签:Git版本控制,团队协作,开发规范,commit message
为你推荐
暂无相关推荐

评论 0