如何编写好的Git提交消息?

时间:2015-10-13 08:24:40

标签: git github message commit git-commit

我知道不要在这里发表意见,但我的问题是,编写简明提交消息的好方法是什么?

我已经使用Git(SmartGit,SourceTree)几个月了,随着我越来越习惯,我开始意识到我的提交信息不明确或者足够详细的历史观看,即我在自己的轨道上。

到目前为止,我一直在编写我的解决方案,例如"正在进行/完成的工作:yadayada .."但即便如此,我觉得我可以做得更好。 欢迎任何事情:)

P.S。我做了很多前端(html,css,js)。

/ P

3 个答案:

答案 0 :(得分:12)

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/

这篇文章得到了你所需要的一切! :)

这是“用身体来解释什么以及为什么与如何相对”是最重要的事情。开发人员通常只是解释他们如何解决他们面临的问题;提交是要知道已经完成了什么,而不是如何完成。

答案 1 :(得分:2)

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

答案 2 :(得分:1)

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

提交留言

为什么
为了避免在许多类中出现重复错误消息,我将所有这些消息集中在一个可以从任何地方访问的大类中,并且可以在需要时(对于不同的模块/库)等进行扩展。

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