编写git commit消息时要遵循的标准

Gan*_*alf 74 git commit-message git-commit

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

一些文件,我查看我的提交Feed并添加...删除...消息占主导地位.有时我不记得我删除了什么或者我添加了什么,layout.css因为我一直做了很多改变,所以我很难想出一个适当的提交消息.

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

Ing*_*kat 77

当你只描述你已经完成的事情时(在技术上但模糊的术语中,比如"添加了一个函数"),你并没有在Git已经存储在提交中的内容中添加太多内容.想象一下自己在一段时间后阅读提交消息; 什么样的摘要可以帮助你最记住/与其他开发人员沟通这种变化的本质?!具体内容取决于您的项目和流程,但我发现这是一个很好的指导方针.

因此,首先在您的提交消息中添加上下文(原因,而不是如何)(例如"frobnize the message to enable persistence")而不是"添加frob()函数").这是更多的努力(你必须反思和思考),但它更值得.

如果您想要了解有关此主题的更多信息,可以获得大量信息,例如Peter Hutterer的博客文章这个有趣的幻灯片.

  • +1强调***为什么***而不是*如何*. (10认同)
  • @Bernard:这只是一个虚假的无意义动词,作为占位符.来自[术语文件]的"frob"和"frobnicate"(http://www.catb.org/jargon/html/F/frob.html). (4认同)
  • 什么是"frobnize"? (2认同)

vij*_*jay 42

50/72模型似乎是一个很好的做法.ie ...第一行应该最多50个字符长,并且应该作为标题服务器.在一个空格后面,第二组线应包裹在72个字符处,并应作为摘要.这是一个SO问题:Git Commit Messages:50/72格式化,讨论相同的问题.

以下是有关该主题的一些详尽说明:

  1. GIT承诺良好实践
  2. 关于Git提交消息的注意事项
  3. 适当的Git提交消息和优雅的Git历史


mim*_*ipc 10

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

  • 实际上,在Git中,您应该使用一条消息,使它清楚地说明修补程序_应用于存储库时将执行的操作-未完成_was_(在其他vcs中更常见)。因此,“修复填充错误”和“侧边栏中的添加菜单”会更加常规。请参阅[在主题行中使用祈使语气](https://chris.beams.io/posts/git-commit/#imperative)(另请参阅[将主题行大写](https://chris.beams。 io / posts / git-commit /#capitalize)) (2认同)