在git上编写多行提交消息是不好的做法? [关闭]

问题描述 投票:0回答:2

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

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

我想知道这是不是一个坏习惯,我应该更喜欢单行提交消息或者至少提供一个标题行。

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

你有什么建议?

git version-control git-commit conventions commit-message
2个回答
3
投票

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

  • 单行,简要总结了变化
  • 空行
  • 多行的所有血腥细节

-1
投票

我认为没有任何理由为什么拥有多条线路是不好的做法。

提交消息应该是提供信息的,任何打算只获得短消息的用法(如某些脚本)将获得主题(您的第一行),忽略其余的,并运行正常。


评论后编辑:

老实说,并且在下面的mkrieger1的评论中进行了有用的交流,你可以在这里改进的一件事是正确使用第一行,它将作为消息主题存储(%s以漂亮的格式),并使用其他行按照预期,即消息体(%b)。当脚本或手动输入的格式都需要两者时,他们将能够使用%B来保存这两者的(未包装的)连接。

© www.soinside.com 2019 - 2024. All rights reserved.