I discussed with Mark Rowe on IRC a bit and it seems like it would be nice if the bug URL could be short enough to just go on one line with the summary. Which turns out to be totally doable. Thus the latest format proposal (the /b/ URL is a redirect):

2009-07-08  Maciej Stachowiak  <m...@apple.com>

       - <http://webkit.org/b/27098> Make prepare-ChangeLog less shouty
      Reviewed by Mark Rowe.

Hypothetical long description goes here. Yeah. Very long and detailed it is.

       * Scripts/prepare-ChangeLog:

On Jul 9, 2009, at 1:32 AM, Maciej Stachowiak wrote:


Now that my attention has been called to it, it's starting to bug me that everyone formats their ChangeLog entries slightly differently. How about this as the canonical format (with prepare-ChangeLog encouraging it)?

2009-07-08  Maciej Stachowiak  <m...@apple.com>

       Make prepare-ChangeLog less shouty
       https://bugs.webkit.org/show_bug.cgi?id=27098

       Reviewed by Mark Rowe.

       * Scripts/prepare-ChangeLog:



So specifically:

- Reviewed by line would go below, not above, to make git users happy (well, happi*er*) - Bug URL remains below one-line description, for git joy and scannability - No angle brackets around URL, so that you can cut/paste or drag it from a URL field without extra work
- No line between URL and summary

Is that a format everyone can live with for ChangeLogs and commit messages? If so, I'll post a patch to update prepare-ChangeLog accordingly.

Regards,
Maciej


_______________________________________________
webkit-dev mailing list
webkit-dev@lists.webkit.org
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev

Reply via email to