[webkit-dev] ChangeLogs

[Konrad Piascik]

There are some changes which have bug descriptions which are complete enough to not need additional comments and any changes to existing scripts should keep this in mind. One way to do this is to check for the number of lines/files the diff has.
Konrad
Sent from my BlackBerry on the Rogers Wireless Network

From: Timothy Hatcher [mailto:timothy at apple.com]
Sent: Wednesday, March 21, 2012 05:29 PM
To: webkit-dev at lists.webkit.org <webkit-dev at lists.webkit.org>
Subject: [webkit-dev] ChangeLogs

Lately I have observed more<http://trac.webkit.org/changeset/111595> and more<http://trac.webkit.org/changeset/111577> and more<http://trac.webkit.org/changeset/111527> changes going into WebKit that lack any details about why a particular change was made. It is intended that the ChangeLog (and commit message) contain some details about your change, not just the bug title and URL.

The contributing information<http://www.webkit.org/coding/contributing.html#changelogs> on subject is pretty sparse, which has likely caused this problem to manifest. However, the example ChangeLog<http://trac.webkit.org/changeset/43259> linked from that page is prime example of what we all should strive for when describing our changes.

To help curb this lack of detail in ChangeLogs, I propose we add script<https://bugs.webkit.org/show_bug.cgi?id=81828> (or augment an existing script) to check for this missing information and inform the contributor. It is clear not all reviewers are asking patch authors to provide this information when reviewing, and such a tool would help enforce it.

— Timothy Hatcher


---------------------------------------------------------------------
This transmission (including any attachments) may contain confidential information, privileged material (including material protected by the solicitor-client or other applicable privileges), or constitute non-public information. Any use of this information by anyone other than the intended recipient is prohibited. If you have received this transmission in error, please immediately reply to the sender and delete this information from your system. Use, dissemination, distribution, or reproduction of this transmission by unintended recipients is not authorized and may be unlawful.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.webkit.org/pipermail/webkit-dev/attachments/20120321/8675fe30/attachment.html>