写好的提交信息

好提交信息的几条原则:

• 说清"做了什么":用动词开头,如"修复登录失败的 bug""新增导出 PDF 功能"
• 聚焦一件事:一次提交只干一件事,信息才好写
• 避免废话:别写 "update""改了点东西""111"
• 团队常用格式:类型: 简述,如 fix: 修复支付超时、feat: 新增搜索框

这是我这次的代码改动(我会粘贴 git diff 的内容)。请帮我写一条规范、清晰的提交信息:第一行是简短摘要(动词开头,不超过 50 字),需要的话再补充几句说明改动原因。

🔧 试一试:给同一次改动写"烂"和"好"两版提交信息(6 分钟)

1. 随便改点代码(比如修一个小 bug),git diff 看一眼你改了什么。
2. 先写一版烂的:git commit -m "改了一下"。过一会儿再看,问自己:光凭这条,知道当时干了啥吗?
3. git commit --amend 改成一版好的:动词开头、说清做了什么、聚焦一件事(如 fix: 修复登录头像不显示)。
4. 把 diff 贴给 Claude,用本节的提示词让它生成一条规范提交信息,和你写的对比。
5. 最后故意把两件不相关的改动混进一次提交,试着写信息——你会发现根本写不清。

你会看到:"改了一下"这类信息对未来的你毫无帮助;而"fix: 修复登录头像不显示"一眼就懂。一次混进多件事,信息就没法写清了。

为什么:提交信息是写给未来的你和队友的。清晰、聚焦单一改动的历史,半年后翻起来能秒懂"这次为什么改";一堆 "update"、"111" 则让所有人抓瞎。一次提交一件事,信息自然好写,历史自然干净。