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

Posted 2023-02-21

【中文标题】在 git 上编写多行提交消息是一种不好的做法吗？ [关闭]

【英文标题】：Is it a bad practice to write multiline commit messages on git? [closed]

【发布时间】：2019-08-25 03:07:33

【问题描述】：

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

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

我想知道这是否是一种不好的做法，我应该更喜欢单行提交消息或至少提供一个标题行。

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

你有什么建议？

【问题讨论】：

这是 Linus Torvalds（git 的创建者）thinks a good commit message looks like

将单行分隔为主题，后跟一个空行，然后在必要时进行描述，这被广泛认为是一种好的做法。除了@CupofJava 提供的链接之外，this post 是一个很好的指南。

在许多存储库查看器（例如，gitk）中，这会将提交显示为* Fix bug abc。如果这是可取的，请自行决定。但是：考虑到这个例子，确实应该有三个提交，而不是一个。

感谢您的来信！是否还有任何合理（技术）原因留下空行等而不是使用项目符号星点？

这在很大程度上取决于您的团队希望如何工作，以及人们如何查看提交消息。此外，大多数项目管理工具（Jira、Trello、Azure DevOps、Tuleap 等）提供了一种将提交消息与实际提交链接的方法，方法是指示您的“票证/项目/工件/产品积压项目/任务”，例如这个@1234

【参考方案1】：

Git 标准（即使你可以随心所欲）是：

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

【讨论】：

我从来没有注意到这个空行推荐，但你是对的。我想这或多或少会产生影响，具体取决于您的习惯和工作流程，但无论如何执行都很好。