编写 git 提交消息时遵循的标准

我发现自己管理的文件非常多(超过60个,但低于70个) ,到目前为止我的提交消息遵循这种模式: 当我添加了类似于 layout.css的内容时,我的提交消息是 “在 layout.css 文件中添加了一些内容”,当我删除一些内容时,我的提交消息是 “从 layout.css 文件中删除了一些内容”

一些文件下来,我看我的提交提要和 加上..。被移除了。消息占主导地位。有时我不记得我删除了什么或者我在 layout.css中添加了什么,因为我一次做了这么多的改变,所以我努力想出一个合适的提交消息。

是否有一个我应该遵循的标准来帮助我提交消息?

67166 次浏览

Git 已经知道在提交中修改了哪些文件,在注释中指定它是没有用的。只要举例说“固定填充错误”或“在侧边栏中添加菜单”。说清楚,就这样。

50/72模式似乎是一个很好的实践。例如... 第一行应该是最大50个字符长度,应该作为一个头服务器。后面跟着一个空格,第二组行应该包装成72个字符,并作为一个摘要。这里有一个 SO 问题: Git 提交消息: 50/72格式,讨论了相同的问题。

以下是关于这一主题的一些详尽说明:

  1. GIT 承诺良好做法
  2. 关于 Git 提交消息的注释
  3. 正确的 Git 提交消息和优雅的 Git 历史

当您仅仅描述您已经完成的操作(在技术上但是模糊的术语中,比如“添加了一个函数”)时,您并没有为 Git 已经存储在提交中的内容添加太多内容。想象一下,过一段时间你自己阅读提交消息; 什么样的摘要可以帮助你记住或者向其他开发人员传达这个改变的本质? !确切的内容取决于您的项目和过程,但是我发现这是一个很好的指导方针。

因此,首先要在提交消息中添加上下文(为什么,而不是 怎么做)(例如,“ frobnize the message to allow restence”) ,而不是“ add Frob () function”)。这是更多的努力(你必须反思和 好好想想) ,但它是值得这么多。

如果您想进一步了解这个主题,这里有大量的信息,例如 这篇由 Peter Hutterer 撰写的博客文章这个滑梯