编写长提交消息以便正确显示的最佳实践是什么？

Question

我通常在 git bash 中写很长的提交消息，以便稍后阅读我的代码的人可以轻松看到我做了什么。例如，在 VS 2013 中的 Windows 表单应用程序中，当设计我编写的表单时，如下所示。

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 上轻松看到所有消息？

Answer 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 也是如此。