如何撰写 Git 提交信息

Avatar of Robin Rendle
Robin Rendle

DigitalOcean 为您旅程的每个阶段提供云产品。立即开始使用 $200 免费信用额度!

Chris Beams 写了一篇关于撰写有帮助的 Git 提交信息的秘密艺术的旧文章,但依然很有用。以下是为什么他认为它如此重要

如果您没有认真考虑什么是优秀的 Git 提交信息,那么您可能没有花太多时间使用 git log 和相关工具。这里存在一个恶性循环:因为提交历史记录没有结构化且不一致,所以人们不会花太多时间使用或维护它。而因为没有人使用或维护它,所以它仍然没有结构化且不一致。

但是,一个精心维护的日志是一个美丽而有用的东西。git blamerevertrebaselogshortlog 和其他子命令都将焕发活力。审查他人的提交和拉取请求将成为一件值得做的事情,而且突然可以独立完成。了解几个月或几年前发生的事情不仅成为可能,而且变得高效。

一个项目的长期成功取决于(除其他因素外)它的可维护性,而维护人员拥有的最强大的工具之一就是项目的日志。值得花时间学习如何正确地维护日志。最初可能很麻烦,但很快就会成为习惯,最终会成为所有参与者的自豪感和生产力来源。

这篇文章与一篇 关于该主题的较新文章 非常搭配。Chris 提供了一个用于一致性的格式,而 Stephen Amaza 在此基础上扩展了该想法,并提出了如何提供更具上下文信息的提交信息的建议。

我一直都很懒惰地撰写提交信息,当然也有一些情况,导致我以一些糟糕且意想不到的方式受到影响。从现在开始,我肯定会使用的一个技巧是:将消息的第一行用作标题,然后在代码快速浏览时不理解的情况下,再添加更长的段落。

直接链接 →