Git 留言 可追溯 第 3 / 3 篇

提交说明:写给人看的

我不追求完美规范,但一定要让三个月后的自己看懂「为什么改」。

本篇有 2 个小节

提交说明写给谁

写给三个月后的自己,以及要 Review 的同事。不是写给 Git 日志凑行数。

我实际用的结构

可改着用
类型: 一句话说明做了什么
为什么:……
验证:本地怎么确认过

类型我常用:fix / feat / refactor / docs。不追求公司级规范时,也至少把「为什么」写清。

写到这里的判断都带个人偏见。你遇到不一样的场景,完全可以反过来用。