给新手的 Git 提交规范:写好 commit message 的五个习惯
刚学 Git 的人,提交信息常常写成“改了一下”“修复 bug”“更新”——当时自己明白,过两周再回看,根本想不起这次提交到底改了什么。更麻烦的是团队协作:别人翻提交历史找某次改动的原因,面对一串含糊的提交信息只能逐个看 diff,效率极低。提交信息不是写给机器的,是写给未来的自己和队友的,养成五个习惯就能明显改善。
第一,标题写“做了什么”,而不是“改了文件”。比如“修复登录页手机号校验失效”就比“改了 login.py”有用得多。标题控制在一行,五十个字以内,让人在提交列表里一眼看懂。
第二,一个提交只做一件事。修 bug 顺手重构了三个函数、又改了两处文案,打包成一个提交,回滚时只能全退全留。拆成小提交,每个提交独立可回滚,出问题定位也快。改动前先问自己:这次提交能不能用一句话说清?说不清就说明混了多件事。
第三,正文补充“为什么”,而不是重复“改了什么”。diff 本身已经写明了改动内容,正文应该写背景:这个 bug 在什么场景触发、为什么选这个方案而不是另一个、有没有已知副作用。写“因为旧接口在弱网下会重复提交订单,所以加了幂等键”,比“加了幂等键”对后来人有价值得多。
第四,关联问题编号。项目用 Issue 或需求单管理时,在正文末尾写上关联编号,比如“关联 Issue #128”。这样从提交能跳到需求背景,从需求也能看到所有相关提交,排查时少翻很多记录。
第五,保持动词和格式统一。团队先定一个简单约定就行,不用照搬复杂规范:比如标题统一用动词开头——“修复、新增、优化、删除”,类型词固定几个即可。约定越简单越容易坚持,坚持下来,提交历史自然变成一份可读的变更日志。
最后提醒两个小细节:提交前用 git diff 过一遍,确认没有误带调试代码、临时文件和敏感信息;写完标题后自己读一遍,想象成陌生人能不能看懂。提交信息写得好,代码评审更快、线上回滚更稳、出了问题也更容易追溯。这不是形式主义,而是给未来的自己省时间。
- 点赞
- 收藏
- 关注作者
评论(0)