Bug 248012

Summary:	Update commit message template to request an explanation of why a PR fixes the bug
Product:	WebKit	Reporter:	David Kilzer (:ddkilzer) <ddkilzer>
Component:	Tools / Tests	Assignee:	David Kilzer (:ddkilzer) <ddkilzer>
Status:	RESOLVED FIXED
Severity:	Normal	CC:	abigail_fox, Hironori.Fujii, jbedard, webkit-bug-importer, zalan
Priority:	P2	Keywords:	InRadar
Version:	WebKit Nightly Build
Hardware:	Unspecified
OS:	Unspecified

Description David Kilzer (:ddkilzer) 2022-11-16 19:08:42 PST

Update commit message template to request a brief explanation of why a PR fixes the bug.

It's always easiest to explain what a patch does, but when reviewing a patch or looking at a previously committed patch, the most useful information that a commit message could contain is why (or how) the changes in the patch actually fix the bug.

Most folks already do this, so this just formalizes a placeholder for it.

Comment 1 Radar WebKit Bug Importer 2022-11-16 19:09:22 PST

<rdar://problem/102447501>

Comment 2 David Kilzer (:ddkilzer) 2022-11-16 19:16:31 PST

Pull request: https://github.com/apple/WebKit/pull/214

Comment 3 David Kilzer (:ddkilzer) 2022-11-16 19:28:24 PST

Pull request: https://github.com/WebKit/WebKit/pull/6579

Comment 4 Fujii Hironori 2022-11-17 17:42:34 PST

We have one more template there. https://github.com/WebKit/WebKit/blob/main/.github/pull_request_template.md

Comment 5 David Kilzer (:ddkilzer) 2022-11-17 19:51:16 PST

(In reply to Fujii Hironori from comment #4)
> We have one more template there.
> https://github.com/WebKit/WebKit/blob/main/.github/pull_request_template.md

Thanks!  Updated the PR.

Comment 6 EWS 2022-11-18 08:30:41 PST

Committed 256835@main (0e7830380b81): <https://commits.webkit.org/256835@main>

Reviewed commits have been landed. Closing PR #6579 and removing active labels.