首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >趣图|git 提交信息

趣图|git 提交信息

作者头像
陶朱公Boy
发布于 2023-08-22 15:06:52
发布于 2023-08-22 15:06:52
4270
举报

大家平时写完代码后,一定会随时提交到git远程仓库吧。

那么问题来了,你的git提交信息是怎么书写的呢?

是否也像上图中那个程序员一样,用什么“fix”之类的内容随意搪塞一下,目的只是能快速完成代码提交呢。

有一点大家要知道,你提交的信息不光是给你自己看的,你身边的同事也很有可能因为某些原因,需要从过往提交历史中,去翻阅某次提交的内容。

但如果我们平时提交的内容满是什么“fix,123,1”等内容,这无疑对查阅的人来说是场灾难。

因为他完全不能理解这种提交信息是什么意思,所以不得不一个接着一个查看每一次的commit信息。如果每次的commit又包含多个文件,可想而知效率有多低。

这里与大家分享一下git作者早期写的关于commit 7条提交规范,希望日后大家能写出一份规范的commit内容。

  • 用空行分开主题和正文
  • 限制主题在50个字母
  • 主题行首字母要大写
  • 不要用句号结束主题行
  • 主题行用祈使语气
  • 每行72个字
  • 在正文部分解释什么,为什么,以及怎么做的

给个示例作为参考,如下:

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2023-06-21,如有侵权请联系 cloudcommunity@tencent.com 删除
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档