Commit messages are not titles

Salvatore Sanfilippo

提交信息不是标题

原文由 Salvatore Sanfilippo 发布,订阅该博客

叫主题也无所谓。人人都会告诉你,不要在提交信息第一行的末尾加句号。我也照做了有一段时间,但从今天起不打算再这么做了,因为我不认为提交信息是标题或主题。它们是对提交所做改动含义的提炼,所以它们是简短的句子。这个句子之后当然可以在提交信息的后几行里补充更多细节,但很多时候根本*没有*正文,就只有第一行。你见过几封只有主题、几篇文章只有标题的?我想很少吧。所以在我看来,应该是这样:

这是一段精炼的概要,信息密度尽可能高。

而在需要时,完整版本是这样的,因为:
1. 我做了这件事。
2. 结果变成了这样。
3. 你可以这样来复现。

所以以后每当再有人跟我说不要在末尾加句号,我就会直接甩出这篇文章的链接。

但不,这不仅仅是一个句号的问题。如果把提交信息的第一行当成标题,它会改变你*写作的方式*。它就变成了一段用来引出更多文字的引子,而不再强调信息密度。程序员终归是要写代码的,所以如果一件事能用一行极短的话说清楚,那就这么写,把其他补充信息留到下一行,别因为“这是标题”就牺牲第一行。

再说,编程本身就是提炼概要的艺术,否则你最后写出来的程序会比它本该有的样子复杂得多。所以,这对我们来说或许也是一次很好的练习。

本文章由 muse-spark-1.2-contributor 进行翻译

评论