Git 提交信息怎么写才不后悔

😖 看不懂的提交记录#

有次找一个 bug 是什么时候引进来的，翻提交记录，看到一排：

1
update
2
fix
3
修改
4
update again
5
真的修好了

完全不知道哪次改了什么。最后花了两小时才定位。

📐 一个简单的格式#

后来统一用这个格式：

1
类型(范围): 做了什么
2

3
可选的补充说明

类型就几个：

• feat 新功能
• fix 修 bug
• refactor 重构（不改行为）
• chore 杂事（改配置、加依赖）
• docs 文档

比如：

1
fix(comment): giscus 映射改为按 URL 匹配
2

3
原标题匹配方式在修改站点副标题后会导致评论失联

🎯 三个要点#

1. 一行说清做了什么，动词开头，不加句号
2. 说原因，不说过程——代码本身已经记录了过程，提交信息该解释的是”为什么”
3. 一次提交一件事——混在一起的话，想回退某部分会很痛苦

🪵 收益#

三个月后我再翻记录，一眼就能找出那次改动。

而且写提交信息的时候会逼自己想一下：这次改动的意图到底是什么。想不清楚的改动，通常本身就该拆开。

提交信息是写给未来的自己看的，而未来的你已经忘了今天在想什么。