On 2017-03-09 5:07 PM, Andrew McCreight wrote: > On Thu, Mar 9, 2017 at 1:55 PM, Nicholas Alexander <nalexan...@mozilla.com> > wrote: > >> On Thu, Mar 9, 2017 at 1:48 PM, Boris Zbarsky <bzbar...@mit.edu> wrote: >> >>> On 3/9/17 4:35 PM, Eric Rescorla wrote: >>> >>>> I'm in favor of good commit messages, but I would note that current m-c >>>> convention really pushes against this, because people seem to feel that >>>> commit messages should be one line. >>>> >>> >>> They feel wrong, and we should tell them so. ;) The first line should >>> include a brief summary of the change. The rest of the commit message >>> should explain details as needed.
Yes, what Boris, David and others said. I think the above is a great and succinct summary of what a good commit message should be like. >> >> Greg Szorc has been a vocal proponent of descriptive commit messages -- I >> consider https://bugzilla.mozilla.org/show_bug.cgi?id=1271035 a work of >> art >> -- and has converted many, including myself, to the cause. I'm thrilled to >> see this practice get traction! >> > > While that is certainly entertaining to read, personally I don't think it > is a great commit message. Anybody who wants to figure out what the patch > is actually doing and why it is doing it has to read through paragraphs > about barleywine to find that out. Ugh.. Yeah this is a pretty bad commit message, definitely a good example of what I'd r-. While I appreciate humor in its right place, I don't think that is the purpose of a commit message. Neither is telling a story. I really hope this is obvious... > On the subject of long commit messages, here's a commit message I wrote > that had 3 paragraphs to explain a patch that just changed a 0 to a 1: > https://hg.mozilla.org/integration/autoland/rev/bf059ec2bdc9 I think the length of the commit message is entirely missing the point. "Typo fix" is a perfectly fine commit message depending on the commit. The point is helping the reviewer and future readers of the commit to understand what it is that it's doing... _______________________________________________ dev-platform mailing list dev-platform@lists.mozilla.org https://lists.mozilla.org/listinfo/dev-platform
