在git上写多行提交消息是一种不好的做法吗?

时间:2019-04-03 14:31:07

标签: git version-control git-commit conventions commit-message

我在git上的提交消息通常如下所示:

* Fix bug abc
* Refactor xyz
* Document 123
* ...

我想知道这是否是不好的做法,我应该选择单行提交消息还是至少提供标题行。

另一方面,这样写起来会不太舒服...

您有什么建议?

2 个答案:

答案 0 :(得分:3)

Git标准(即使您可以随意做)是:

  • 单行并简要说明更改
  • 空行
  • 多行中的所有血腥细节

答案 1 :(得分:-1)

我看不出有多于一行的不良做法的任何原因。

提交消息应该提供信息,任何只想收到短消息的用法(例如某些脚本)都会得到主题(您的第一行),忽略其余内容,并且运行良好。


评论后编辑:

说实话,在与下面的mkrieger1进行有用的评论交流之后,您可以在此处改进的一件事是正确使用第一行,该行将存储为消息 subject ({ {1}}(以漂亮的格式),并按预期使用其他行,即消息 body %s)。当脚本或手动键入的格式都需要两者时,它们将能够与%b一起使用,该{+1}可以容纳这两者的(未包装的)串联。