[Development] Please add [ChangeLog] entries to your commits!

Mitch Curtis mitch.curtis at qt.io
Wed May 31 16:48:45 CEST 2017

> -----Original Message-----
> From: Development [mailto:development-bounces+mitch.curtis=qt.io at qt-
> project.org] On Behalf Of Robin Burchell
> Sent: Wednesday, 31 May 2017 3:02 PM
> To: development at qt-project.org
> Subject: Re: [Development] Please add [ChangeLog] entries to your commits!
> On Wed, May 31, 2017, at 02:50 PM, Oswald Buddenhagen wrote:
> > On Wed, May 31, 2017 at 02:38:53PM +0200, Robin Burchell wrote:
> > > To me, it's implicit that each release will ideally have
> > > improvements in terms of stability, so I think that there's less
> > > point in focusing on them, unless they are a major newsworthy item:
> > > something like "sorry we released 1.0.0 yesterday, but it turns out
> > > that feature foo was totally broken, have 1.0.1 today to fix that"
> > > would be newsworthy, but "we fixed a crash that has existed for the
> > > past 3 years" - less so, but that's my own personal view.
> > >
> > the trolltech policy was to always add a changelog entry when there
> > was a proper bug report. that seems reasonable, because there is (or
> > at least
> > was) somebody waiting for that fix.
> Yes, however, if they are waiting for the fix, one would assume they are
> also subscribed to the bug tracker, and presumably watching the bug.
> They'll get a notification when the bug state changes (and a fix version
> is added). I should note that I'm not opposed to mentioning more stuff, I
> was just talking about my own editorial process when digging around after
> stuff missing changelog entries.

It's hard to beat the automatic notifications that Jira has. Anyone who has a business interest in a bug should be watching it in Jira.

I don't remember seeing ChangeLog entries for fixes for non-critical bugs, and I imagine it would be really hard to get people to do this, which is why I was suggesting (on #qt-labs, and I'm probably not the first) that it would be good to have a way to automatically add one based on the task number and the title of the bug report (either as a post commit hook or maybe some script that the changelog script calls to fetch the info from git log). For example, for https://bugreports.qt.io/browse/QTBUG-1000, it could be something like:

[ChangeLog][QTBUG-1000] Fixed "QTableWidget Row Remove/Insert bug"

The titles could of course be edited by the maintainer (either after the changelog has been generated, or they could be more conscientious about editing bad bug report titles), but for the most part the titles are fairly sane and wouldn't need changing.

> --
>   Robin Burchell
>   robin at crimson.no
> _______________________________________________
> Development mailing list
> Development at qt-project.org
> http://lists.qt-project.org/mailman/listinfo/development

More information about the Development mailing list