如何写出好的 Git 提交信息？ [关闭]答案

【问题标题】：How to write a good Git commit message? [closed]如何写出好的 Git 提交信息？ [关闭]
【发布时间】：2016-01-10 21:47:39
【问题描述】：

我知道在这里不要固执己见，但我的问题是，编写简洁的提交消息的好方法是什么？

我已经使用 Git (SmartGit, SourceTree) 几个月了，随着我越来越习惯它，我开始意识到我的提交消息不够清晰或不够详细，无法查看历史记录即我陷入了自己的轨道。

到目前为止，我一直在写我的解决方案，比如“正在进行/完成：yadayada..”，但即便如此，我觉得我可以做得更好。欢迎任何东西:)

附：我做了很多前端（html、css、js）。

【问题讨论】：

你看过官方文档中的this吗？

标签： git github message commit git-commit

【解决方案1】：

Separate subject from body with a blank line
Limit the subject line to 50 characters
Capitalize the subject line
Do not end the subject line with a period
Use the imperative mood in the subject line
Wrap the body at 72 characters
Use the body to explain what and why vs. how

来源：http://chris.beams.io/posts/git-commit/

这篇文章有你需要的一切！ :)

这个“用身体来解释什么、为什么和如何”是最重要的。开发人员通常只是解释他们如何解决他们面临的问题；提交是要知道已经完成了什么，而不是如何完成。

【讨论】：

我认为值得注意的是，第 5 项（使用祈使语气）非常基于意见（充其量）和宗教战争的基础（最坏的情况）。例如这两个问题，here 和 here
嗯，大部分都是基于意见的......但我认为 Git 本身告诉人们对提交使用命令式，所以我想这是一个好方法！（编辑：实际上只是在 git 所做的一个答案中看到过；显然这不是一个规则，而是一个普遍的偏好）

【解决方案2】：

基本上，您应该在提交中写下您所做的事情。就像您在应用程序中创建用户身份验证一样，通常，您不会提交每个控制器的方法、模型、视图的部分等。您应该添加您为任务完成的所有内容并将其作为单个提交提交。

【讨论】：

可能会补充一点，它很简单：一个问题修复/一个功能完成一次提交！
是的，你完全正确！

【解决方案3】：

我的做法如下：
标题：
ANDR-10500：重构了数据库错误消息。

提交消息：

为什么：
为了在许多类中不出现重复的错误消息，我将它们集中在一个大类中，该类可以从任何地方访问，也可以在需要时扩展（针对不同的模块/库）等等。

你做了什么：
我将所有数据库类中的所有错误消息重构为一个包含所有可能发生的错误的类。该类是单例类等等。

【讨论】：

git 文档 (git-scm.com/book/en/v2/…) 说在提交消息中对动词使用祈使语气，在他们的示例中，它们不会以句点结束消息。从那个链接：“用命令式写你的提交消息：“修复错误”而不是“修复错误”或“修复错误”。”