[Webkit-unassigned] [Bug 81828] check-webkit-style (and the style bot) should complain about ChangeLogs without comments

[bugzilla-daemon at webkit.org]

https://bugs.webkit.org/show_bug.cgi?id=81828





--- Comment #8 from Maciej Stachowiak <mjs at apple.com>  2012-03-21 13:43:42 PST ---
(In reply to comment #3)
> I would encourage you to mark this bug as WONTFIX.  It's tempting to make the style bot a nag for filling out TPS reports, but it's a better tool when it tells you something interesting that you'd like to know rather than when it nags you.

Having useful comments in the ChangeLog (and therefore in the commit message) is intended to be a way to enable other contributors to better understand your change, not time-wasting bureaucracy.

It's true that we haven't been very good about consistently practicing good ChangeLog comments, but as the project grows, it becomes more important to consider the human audience of one's changes, not just the machine audience.

Perhaps a good first step would be to expand <https://www.webkit.org/coding/contributing.html#changelogs> to make more clear what is expected. It says the ChangeLog should "describe your change" but it could be more clear that bug title and URL is generally not in itself a sufficient description, at least for a nontrivial change.

-- 
Configure bugmail: https://bugs.webkit.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.