Bug 99268 – prepare-ChangeLog adds "Additional information of the change such as approach, rationale" where it doesn't make sense

• Status: RESOLVED
• Resolution: FIXED
• Component: Tools / Tests

prepare-ChangeLog adds "Additional information of the change such as approach, rationale" where it doesn't make sense

Created attachment 168584 [details]
Add "Additional information" line only for change logs under Source

[Alexey Proskuryakov]

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.

I find that having the instructions on how to write a change log entry in the change log entry template is a nuisance.

[Alexey Proskuryakov]

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.

[Alexey Proskuryakov]

> 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.

(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.

[Alexey Proskuryakov]

As for rationale - contributors frequently forget to remove this line regardless of location, which is a waste of everyone's time.

Created attachment 180291 [details]
Never add the “Additional information” line

[Ryosuke Niwa]

This was added in http://trac.webkit.org/changeset/122192.

[Ryosuke Niwa]

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

[Ryosuke Niwa]

(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.

Fixed in <http://trac.webkit.org/r138259>.