[webkit-dev] Proposal: Commit messages should start with a one-line summary of the change

Ryosuke Niwa rniwa at webkit.org
Thu Jun 30 16:57:13 PDT 2011


On Thu, Jun 30, 2011 at 4:52 PM, Darin Adler <darin at apple.com> wrote:

> I don’t think it’s a good idea to add yet another thing to every change log
> entry.
>
> I do think that given the tools behavior you described, we should move the
> reviewer text after the bug title and patch description paragraph, even
> though you explicitly said that’s not what you are proposing.
>

I agree with Darin's point.

While I get annoyed by the fact trac log pages don't show any useful
information:
rniwa at webkit.org: 2011-06-30
Ryosuke Niwa
Software Engineer
Google Inc.


< rniwa at webkit.org <rniwa at webkit.org>> Reviewed by Kent …

But that can be addressed by giving the right commit message extracted from
the change log as Mark suggested:
On Thu, Jun 30, 2011 at 2:10 PM, Mark Rowe <mrowe at apple.com> wrote:
>
> Most ChangeLog entries already have a one-line summary immediately after
> the "Reviewed by" line.  I'm not sure that there's any benefit to reordering
> these parts of the ChangeLog.
>
> > Given this format, commit-log-editor will put the summary right at the
> top of the commit log. webkit-patch will require modifications to do this
> correctly, as represented by <
> https://bugs.webkit.org/show_bug.cgi?id=26755>.
>
> commit-log-editor already does the right thing given our current format.
>  It's just that many people have switched to using webkit-patch, and it was
> never taught the correct format for commit messages.


We should just fix webkit-patch so that it uses the right commit message.

- Ryosuke
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.webkit.org/pipermail/webkit-dev/attachments/20110630/ac2addc5/attachment.html>


More information about the webkit-dev mailing list