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

John Wilander wilander at apple.com
Thu Nov 17 13:44:10 PST 2022


> On Nov 17, 2022, at 12:43 PM, Simon Fraser via webkit-dev <webkit-dev at lists.webkit.org> wrote:
> 
>> 
>> On Nov 17, 2022, at 12:23 PM, David Kilzer via webkit-dev <webkit-dev at lists.webkit.org> wrote:
>> 
>> Hi,
>> 
>> 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://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!).
> 
> I would remove the word “Short”. Sometimes a longer explanation is needed. More that one paragraph is often a good thing (para 1 explains the bug, para 2 explains how the change fixes it).

Good idea to have the placeholder there. ���� I also thing the word “short” can be dropped.

   Regards, John

> _______________________________________________
> webkit-dev mailing list
> webkit-dev at lists.webkit.org <mailto:webkit-dev at lists.webkit.org>
> https://lists.webkit.org/mailman/listinfo/webkit-dev

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


More information about the webkit-dev mailing list