接手过一个项目,打开 git log,满屏的”111″”222″”fix””update””test”。
我盯着这些提交信息,完全不知道每次改了什么。想回滚到某个稳定版本,只能一个个 checkout 过去试,像拆盲盒。
后来自己写代码,强迫自己写清楚提交信息:修复了什么 bug、为什么改、改了哪些文件。一开始觉得麻烦,但三个月后回头看,能清楚知道每个版本干了什么,值。
最规范的写法是:第一行简短总结(50字内),空一行,下面详细说明。比如:
修复登录页表单验证失效的问题 - 原正则表达式未过滤特殊字符,导致 SQL 注入风险 - 更新验证规则,增加前后端双重校验 - 关联 issue #42
写给自己看,也是写给未来的维护者看。谁知道未来接手代码的是不是你自己呢。
—— 2026.6.13