我正在从头开始一个新的存储库,我想确保我开始的时候是正确的。我是从以前一个非常使用github的开发人员那里谈论的,我想在继续开发他们的代码之前修复它。
我已经阅读了很多关于github的文章,明天我将把存储库放在一起。我希望得到您对我将要使用的git提交消息的格式的意见,如果我做了任何不正确的事情(格式,太详细等等),我所有的提交都将遵循相同的格式,所以我想得到正确的。
下面是我的一条提交消息的示例,谢谢。
“增加WIFI重新连接
添加代码,以强制WIFI模块保存和重新启动,如果它已经超过45秒,因为一个包已成功发送。
这是为了解决WIFI模块与其网络失去连接的问题。一旦断开连接,它只会尝试重新连接有限的次数。
现在,如果WIFI模块断开连接或数据在45秒内无法正确发送,则将强制重新启动,该模块将尝试在唤醒时连接和传输。“
发布于 2016-10-13 15:04:59
所以我决定用你们在回答和回复中给我的信息来回复我自己的帖子。我这么做是因为这更多的是一个基于观点的问题,不能得到真正的回答,我想关闭它。
我已经决定我将添加更短的提交消息,并使用github上的问题跟踪器(我刚刚发现,感谢大家)来保存更详细的信息。我的新提交消息格式以及我的问题、开始和结束评论都在下面,以防对其他人有帮助。再次感谢各位,我真的很感谢你们的建议。
发行评论:
WIFI模块失去与其网络的连接。一旦断开,它将尝试重新连接有限的次数,然后超时。
发布贴切评论:
添加代码,以强制WIFI模块保存和重新启动,如果它已经超过45秒,因为一个包已成功发送。无论网络连接如何,都会发生保存和重新启动。唤醒后,模块将尝试连接和传输。
提交消息:
添加WIFI重新连接
修复问题#1.添加WIFI重新连接。如果上次成功数据包后超过45秒,现在自动尝试重新连接。
发布于 2016-10-13 13:50:23
写一条好的提交信息是很重要的,而且你花了这么多心思去写它是很棒的。一般来说,经验法则是用现在时写,写简短的、描述性的信息。
也许更重要的是,提交应该包含小的、逻辑的工作单元。在您的示例中,提交中包含的代码可能是大量的代码,可能太多了。您的示例看起来像是一个很棒的合并提交,或者合并/压缩提交消息。
因此,较小的提交、当前时态短消息,只在必要时使用扩展描述。
发布于 2016-10-13 14:01:15
我通常的做法是提供最少而清晰的提交消息,以缩短历史。想象一下,查看具有与您的提交消息相似的文件的git日志,就像阅读这本书一样。
另一方面,一些问题的修复需要更多的阐述和解释,这就是问题跟踪的地方。您可以在提交消息中提及问题号以供参考。当您在提交消息中提供神奇短语并推动更改时,Github甚至是允许自动关闭问题。。
当然,每个开发人员都有自己的风格,这个问题绝对是基于意见的。
https://stackoverflow.com/questions/40022820
复制相似问题