“写代码一分钟,写 Commit Message 两行泪”
—— 一位被历史代码支配的程序员
想象一下,你正调试一个项目,git log 滚动出来的全是这样的信息:
fix bug update 123 final_final_really_final
是不是感觉灵魂受到了暴击? 半年后的你,根本不知道自己当时修了啥 bug,更别提帮别人 review 代码了
Commit Message 就像项目的“日记”,写好它,团队能心有灵犀;写烂它,未来的自己会哭晕在厕所
业界其实早有共识,最常见的就是 Conventional Commits 规范
它给 Commit Message 设计了一套语法,简单又高效:
<type>(<scope>): <subject>
例如:
feat(auth): 新增用户登录功能 fix(api): 修复分页接口返回条数错误 docs(readme): 更新使用文档示例
这样一眼扫过去,就能知道每个提交是 新增功能、修 bug、写文档,还是别的
type(scope) 建议用英文,描述可以中英文结合Commitlint
自动校验 commit 格式,不合格直接拦下
Husky
Git hooks 工具,可以在 git commit 前强制执行校验,让团队所有人都守规范
Commitizen (cz-cli)
交互式输入 commit message,手把手帮你填,完全不用担心格式
changelog 工具
例如 standard-version,可以根据 commit 自动生成更新日志
程序员的世界里,代码会老去,Bug 会重生,但 commit log 会一直陪你 所以,下次提交的时候,别再敷衍了事,让你的 commit 规范起来吧
毕竟:Commit 不规范,队友两行泪;Message 写得好,自己少烦恼。


本文作者:AsZero
本文链接:
版权声明:本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!