[webkit-dev] Changes to prepare-ChangeLog

[David Kilzer]

On Wednesday, July 1, 2009 10:44:16 PM, Eric Seidel <eric at webkit.org> wrote:


> Results in:
> 2009-07-01  Eric Seidel  <eric at webkit.org>
> 
>         Reviewed by NOBODY (OOPS!).
> 
>         prepare-ChangeLog should have a --bug= argument and use it for
url autofill
>         https://bugs.webkit.org/show_bug.cgi?id=26383
> 
>         DETAILED DESCRIPTION OF THE CHANGES GOES HERE. (OOPS!) SEE:
>         http://webkit.org/coding/contributing.html FOR MORE INFORMATION
> 
>         Tests: fast/foo.html
> 
>         * foo.cpp: Added.


- I prefer having "Bug NNNNN: " before the actual bug description so I don't have to parse the URL myself for the bug number.  It also acts as a visual marker when I read the ChangeLog entry.

- I like putting angle brackets "<>" around the URL to set it off visually from other text.

- I generally move the "Reviewed by" line after the bug number/description/URL.  When you're reading a ChangeLog entry/commit message (especially an older one), it's generally much more interesting which bug is being fixed rather than knowing who reviewed it.  (Also, putting the bug description first makes git's one-line description of each commit much more useful than either having a list of dates and the person who wrote the patch or having a list of patch reviewers.)

Dave
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.webkit.org/pipermail/webkit-dev/attachments/20090702/d1fcb66c/attachment.html>