Git 提交消息结构
Git Commit message structure
我正在从头开始一个新的存储库，我想确保我正确地开始了。我正在与一位非常使用 github 的前开发人员交谈，我想在继续开发他们的代码之前修复它。
我在 github 上做了很多阅读，明天我将把存储库放在一起。我希望得到您对我将使用的 git 提交消息格式的意见，如果我做错了什么（格式、太详细等），我所有的提交都将遵循相同的格式，所以我想做对了。
这是我提交消息之一的示例，在此先感谢。
"添加WIFI重新连接
添加了代码以强制 WIFI 模块在数据包发送成功超过 45 秒后保存并重启。
这是为了解决 WIFI 模块失去网络连接的问题而添加的。一旦断开连接，它只会尝试重新连接有限的次数。
现在如果WIFI模块断开连接或数据未正确发送45秒，将强制重启，模块将在唤醒时尝试连接和传输。"
写一个好的提交信息很重要，而且你能花这么多心思真是太棒了。一般来说，经验法则是使用现在时和简短的描述性消息。
也许更重要的是，提交应该包含小而合乎逻辑的工作单元。在您的示例中，该提交中包含的代码可能 很多 代码，也许太多了。您的示例看起来像是一个很棒的合并提交，或 merge/squash 提交消息。
所以，较小的提交，现在时的短消息，只在必要时使用扩展描述。
我通常的做法是使用最少但清晰的提交消息，以缩短历史。想象一下，查看与您的提交消息相似的文件的 git 日志，就像读书一样。
另一方面，一些问题修复需要更多的阐述和解释，这就是问题跟踪的用武之地。您可以在提交消息中提及问题编号以供参考。 Github 甚至 allows to automatically close the issue 当您在提交消息中提供魔法短语并推送更改时。
当然，每个开发者都有自己的风格，这个问题完全是个人意见。
所以我决定使用你们在回答和回复中提供给我的信息来回答我自己的 post。我这样做是因为这更像是一个基于意见的问题，无法真正回答，我想将其关闭。
我决定添加更短的提交消息并使用 github 上的问题跟踪器（我刚刚发现，感谢大家）来保存更详细的信息。我的提交消息的新格式以及我的问题开始和结束评论如下，以防它可能对其他人有所帮助。再次感谢大家，我真的很感谢所有的建议。
发表评论：
WIFI 模块失去网络连接。一旦断开连接，它将在超时前尝试重新连接有限次数。
发表关闭评论：
添加了代码以强制 WIFI 模块在数据包成功发送后超过 45 秒后保存并重启。无论网络连接如何，都会进行保存和重启。唤醒时，模块将尝试连接和传输。
提交消息：
添加WIFI重连
修复问题 #1。添加 WIFI 重新连接。如果自上次成功数据包以来超过 45 秒，现在会自动尝试重新连接。
我正在从头开始一个新的存储库，我想确保我正确地开始了。我正在与一位非常使用 github 的前开发人员交谈，我想在继续开发他们的代码之前修复它。
我在 github 上做了很多阅读，明天我将把存储库放在一起。我希望得到您对我将使用的 git 提交消息格式的意见，如果我做错了什么（格式、太详细等），我所有的提交都将遵循相同的格式，所以我想做对了。
这是我提交消息之一的示例，在此先感谢。
"添加WIFI重新连接
添加了代码以强制 WIFI 模块在数据包发送成功超过 45 秒后保存并重启。
这是为了解决 WIFI 模块失去网络连接的问题而添加的。一旦断开连接，它只会尝试重新连接有限的次数。
现在如果WIFI模块断开连接或数据未正确发送45秒，将强制重启，模块将在唤醒时尝试连接和传输。"
写一个好的提交信息很重要，而且你能花这么多心思真是太棒了。一般来说，经验法则是使用现在时和简短的描述性消息。
也许更重要的是，提交应该包含小而合乎逻辑的工作单元。在您的示例中，该提交中包含的代码可能 很多 代码，也许太多了。您的示例看起来像是一个很棒的合并提交，或 merge/squash 提交消息。
所以，较小的提交，现在时的短消息，只在必要时使用扩展描述。
我通常的做法是使用最少但清晰的提交消息，以缩短历史。想象一下，查看与您的提交消息相似的文件的 git 日志，就像读书一样。
另一方面，一些问题修复需要更多的阐述和解释，这就是问题跟踪的用武之地。您可以在提交消息中提及问题编号以供参考。 Github 甚至 allows to automatically close the issue 当您在提交消息中提供魔法短语并推送更改时。
当然，每个开发者都有自己的风格，这个问题完全是个人意见。
所以我决定使用你们在回答和回复中提供给我的信息来回答我自己的 post。我这样做是因为这更像是一个基于意见的问题，无法真正回答，我想将其关闭。
我决定添加更短的提交消息并使用 github 上的问题跟踪器（我刚刚发现，感谢大家）来保存更详细的信息。我的提交消息的新格式以及我的问题开始和结束评论如下，以防它可能对其他人有所帮助。再次感谢大家，我真的很感谢所有的建议。
发表评论：
WIFI 模块失去网络连接。一旦断开连接，它将在超时前尝试重新连接有限次数。
发表关闭评论：
添加了代码以强制 WIFI 模块在数据包成功发送后超过 45 秒后保存并重启。无论网络连接如何，都会进行保存和重启。唤醒时，模块将尝试连接和传输。
提交消息：
添加WIFI重连
修复问题 #1。添加 WIFI 重新连接。如果自上次成功数据包以来超过 45 秒，现在会自动尝试重新连接。