Bug 99268 - prepare-ChangeLog adds "Additional information of the change such as approach, rationale" where it doesn't make sense
Summary: prepare-ChangeLog adds "Additional information of the change such as approach...
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: Tools / Tests (show other bugs)
Version: 528+ (Nightly build)
Hardware: Unspecified Unspecified
: P2 Normal
Assignee: mitz
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-10-14 11:12 PDT by mitz
Modified: 2012-12-20 09:28 PST (History)
3 users (show)

See Also:


Attachments
Add "Additional information" line only for change logs under Source (1.93 KB, patch)
2012-10-14 11:14 PDT, mitz
ap: review-
Details | Formatted Diff | Diff
Never add the “Additional information” line (1.36 KB, patch)
2012-12-20 00:33 PST, mitz
ap: review+
Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description mitz 2012-10-14 11:12:45 PDT
prepare-ChangeLog adds "Additional information of the change such as approach, rationale" where it doesn't make sense
Comment 1 mitz 2012-10-14 11:14:28 PDT
Created attachment 168584 [details]
Add "Additional information" line only for change logs under Source
Comment 2 Alexey Proskuryakov 2012-10-15 10:25:24 PDT
I'm actually finding this location more more useful for non-source changes. When you only modify tests, rationale on top is usually most appropriate, while for source code changes, it's often just bug title and per-function comments.

Also, there is a lot of source code under Tools.
Comment 3 mitz 2012-10-15 10:28:43 PDT
I find that having the instructions on how to write a change log entry in the change log entry template is a nuisance.
Comment 4 Alexey Proskuryakov 2012-10-15 14:10:50 PDT
Comment on attachment 168584 [details]
Add "Additional information" line only for change logs under Source

I'm not sure why I didn't mark this r-, I totally meant to.
Comment 5 Alexey Proskuryakov 2012-10-15 14:11:25 PDT
> I find that having the instructions on how to write a change log entry in the change log entry template is a nuisance.

Sounds like they should be removed unconditionally then.
Comment 6 mitz 2012-10-15 14:15:11 PDT
(In reply to comment #5)
> > I find that having the instructions on how to write a change log entry in the change log entry template is a nuisance.
> 
> Sounds like they should be removed unconditionally then.

I’d prefer that.
Comment 7 Alexey Proskuryakov 2012-11-08 14:09:48 PST
As for rationale - contributors frequently forget to remove this line regardless of location, which is a waste of everyone's time.
Comment 8 mitz 2012-12-20 00:33:52 PST
Created attachment 180291 [details]
Never add the “Additional information” line
Comment 9 Ryosuke Niwa 2012-12-20 00:36:42 PST
This was added in http://trac.webkit.org/changeset/122192.
Comment 10 Ryosuke Niwa 2012-12-20 00:44:01 PST
I think we can solve the problem of new contributors not inserting the description at the right place by improving http://www.webkit.org/coding/contributing.html#changelogs
Comment 11 Ryosuke Niwa 2012-12-20 01:19:33 PST
(In reply to comment #10)
> I think we can solve the problem of new contributors not inserting the description at the right place by improving http://www.webkit.org/coding/contributing.html#changelogs

Submitted a patch on https://bugs.webkit.org/show_bug.cgi?id=105506.
Comment 12 mitz 2012-12-20 09:28:08 PST
Fixed in <http://trac.webkit.org/r138259>.