Git提交消息结构

我正在从头开始创建一个新的存储库，我希望确保正确开始。我之前的一位开发人员非常使用github，我想在继续开发他们的代码之前修复它

我已经在github上读了很多书，明天我将把存储库组装起来。我希望得到你对我将使用的git提交消息格式的意见，如果我做了任何不正确的事情（格式、太详细等），我的所有提交都将遵循相同的格式，所以我希望得到正确的格式

下面是我的一条提交消息的示例，提前谢谢

“添加WIFI重新连接

添加了代码，如果数据包成功发送后超过45秒，则强制WIFI模块保存并重新启动

这是为了修复WIFI模块与网络失去连接的问题。一旦断开连接，它将只尝试重新连接有限的次数

---

现在，如果WIFI模块断开连接或数据在45秒内未正确发送，则将强制重新启动，模块将尝试在唤醒时连接和传输。”

编写一条好的提交消息非常重要，您花了这么多心思在这条消息上真是太棒了。一般来说，经验法则是用现在时态写作和写简短的描述性信息

也许更重要的是，提交应该包含小型的逻辑工作单元。在您的示例中，提交中包含的代码可能太多，可能太多。您的示例看起来像一个很好的合并提交或合并/挤压提交消息

---

因此，较小的提交，现在时短消息，仅在必要时使用扩展描述

我通常的做法是使用最少但清晰的提交消息，以缩短历史记录。想象一下，查看一个文件的git日志，它与您的文件有类似的提交消息，就像阅读这本书一样

另一方面，一些问题修复需要更多的阐述和解释，这就是问题跟踪的意义所在。您可以在提交消息中提及问题编号以供参考。Github，即使您在提交消息中提供了神奇的短语并推动更改

---

当然，每个开发者都有自己的风格，这个问题绝对是基于意见的。

所以我决定用你们在回答和回复中给我的信息来回答我自己的帖子。我这样做是因为这更多的是一个基于意见的问题，无法真正得到回答，我想结束它

我已经决定，我将添加更短的提交消息，并使用github上的问题跟踪器（感谢大家，我刚刚发现了这个问题）来保存更详细的信息。下面是我提交消息的新格式以及我的问题开始和结束评论，以防它可能会帮助其他人。再次感谢各位，我真的很感谢你们的建议

问题评论：

WIFI模块与其网络失去连接。一旦断开连接，它将在超时前尝试重新连接有限的次数

问题结束评论：

添加了代码，如果数据包成功发送后超过45秒，则强制WIFI模块保存并重新启动。无论网络连接如何，都会进行保存和重新启动。在wakup上，模块将尝试连接和传输

提交消息：

添加WIFI重新连接

---

修复问题#1。添加WIFI重新连接。现在，如果自上次成功数据包后超过45秒，将自动尝试重新连接

我只给我的2美分。您应该尝试编写简短的提交消息。如果您有这么长的提交消息，我可能会在问题系统中创建问题，而只是引用提交消息中的问题。如“修复#346：添加WIFI重新连接，如果自上次数据包后超过45秒，现在自动尝试重新连接”。然后，问题的更详细描述以及建议和实施的修复将出现在问题上，而不在提交日志中。你应该试着描述一下你做了什么，把原因留给这个问题。然而，我也将投票以“主要基于观点”结束这个问题，因为这里没有明确的答案，只有观点。这也是为什么我写上面的评论是作为评论，而不是回答。嗨，小姐，谢谢你的回复。我会接受你的建议，尽量缩短我的留言。不幸的是，没有问题跟踪系统。这是一家小公司，老开发商在我开始之前就离开了。我现在是唯一的开发者，所以我想我必须开始使用它。您觉得在我的源代码的历史记录部分添加一个简短的提交和细节怎么样？我只是假设，因为您使用了标记[github]，您的代码就在github上，然后您已经有了一个问题跟踪程序。我绝对不会在源代码中编写类似提交的消息。如果您没有问题跟踪程序，并且无法使用问题跟踪程序（无论出于何种原因），我会在我的建议和您的建议之间写一些东西。我仍然认为你应该在某个地方有一个todo列表，列出你需要解决的问题，并且可以参考该列表，但是在完全没有该列表的情况下，写下对你有意义的内容。嗨，女士，非常感谢你的帮助，我是github的新手，这周才开始学习。我刚刚查看了github上的问题部分，我将100%地进行研究并从现在开始使用它。谢谢你的回复。我实际上是一个相当小的代码量。一个新函数，几个变量，只需更改一些代码流。这就是我使用这个例子的原因，它是一个非常小的修改，有很大的解释。我保证在我有问题和需要恢复的情况下，我会定期提交很多。我能问一下你会如何用上面的内容来写它吗