[webkit-dev] Update commit log template to add placeholder for explanation of why a patch fixes a bug

David Kilzer ddkilzer at webkit.org
Thu Nov 17 12:23:54 PST 2022


The following PR adds placeholder text in the commit log template to remind authors to explain why a change fixes a bug:

Bug 248012: Update commit message template to request a brief explanation of why a PR fixes the bug
<https://bugs.webkit.org/show_bug.cgi?id=248012 <https://bugs.webkit.org/show_bug.cgi?id=248012>>
<https://github.com/WebKit/WebKit/pull/6579 <https://github.com/WebKit/WebKit/pull/6579>>

It looks like this:

Need a short description (OOPS!).
Need the bug URL (OOPS!).
Include a Radar link (OOPS!).

Reviewed by NOBODY (OOPS!).

Short explanation why this fixes the bug (OOPS!).

* path/to/File.cpp:

Since this is effectively a policy change, Jonathan suggested I post it here first before the change is landed.

I believe many WebKit contributors already do this anyway, and it’s always been a best-practice to explain why a change fixes a bug (vs. what a patch does, which is usually obvious by reading the code), so this text just serves as a reminder to write a short explanation for every relevant patch.

Note that the line may be simply be deleted when it doesn’t apply (such as gardening, a build fix, etc.).

Any feedback on this change?


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.webkit.org/pipermail/webkit-dev/attachments/20221117/9ddead9f/attachment.htm>

More information about the webkit-dev mailing list