【问题标题】:Writing long commit messages in git?在 git 中编写长提交消息?
【发布时间】:2014-03-29 12:32:12
【问题描述】:

我通常在我的 git bash 中编写长提交消息,以便稍后阅读我的代码的人可以很容易地看到我做了什么。例如在 windows 窗体应用程序中的 vs2013 中设计我编写的表单时。

git commit -m "Add Name,age ,height,weight and salary labels with corresponding text boxes and more over a Submit Button..."

问题是当我输入git log --oneline 时,它没有显示整个消息并截断了其中的一部分。 我的问题是,在 git 中编写长提交消息的方法是什么,限制是什么以及如何显示它们以便可以在 git bash 上轻松查看所有消息?

【问题讨论】:

标签: git


【解决方案1】:

git 显示日志消息的方式是它会占用第一行并在git log --oneline 中使用它,然后在使用普通git log 时显示其他任何内容,只要第一行和第一行之间有一个空行第二部分:

Add summary line here

An example of how to write long commit messages.
Blah blah blah blah blah.
SKADOOSH!

许多人使用它的标准,将第一行用作提交中更改的摘要,并将其长度保持在最大 50 个字符,以便在使用 git log --oneline --graph 时可以适应。这实际上是 Linux 内核和 git 项目维护者自己使用的标准(GitHub 也推广它)。

您可能会觉得 50 个字符太短,因此您可以使用的另一个标准是将摘要保持在 72、78 或 80 个字符的最大值。

对于提交消息的其余部分,将最大行长度保持在最大 72、78 或 80 个字符也可能会有所帮助,例如,如果您经常将监视器屏幕分成两半,而将浏览器或编辑器分成两半另一半。许多编辑器都有快捷方式,可以为您自动将长行换行到最大列长度。

例如,在 Sublime Text 中,命令是 ALT + CMD + q。 Vim 也有一些快捷方式可以做到这一点(gq 就是其中之一),但您需要配置最大行长才能使其工作。 Sublime Text 也是如此。

【讨论】:

  • 此外,将其保持在 50 个字符会鼓励较小的提交,这可以使调试更容易。
猜你喜欢
  • 2016-07-06
  • 2011-11-08
  • 2012-06-16
  • 1970-01-01
  • 2016-02-01
  • 2012-05-04
  • 2011-04-25
  • 2013-02-25
  • 2011-09-07
相关资源
最近更新 更多