[Development] Please add [ChangeLog] entries to your commits!
robin.burchell at crimson.no
Wed May 31 14:38:53 CEST 2017
My rule of thumb (when editing qtdeclarative's, for the last releases)
has been to include things depending on the "size" of the release. Small
(patch level) release? Include more bugs. Large (.0) release? Less focus
on bugs, more focus on architectural changes, feature additions, etc.
Any behavioral changes are always something that should be mentioned, of
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.
robin at crimson.no
On Wed, May 31, 2017, at 02:30 PM, Mitch Curtis wrote:
> > -----Original Message-----
> > From: Kai Koehne
> > Sent: Tuesday, 30 May 2017 9:31 AM
> > To: Mitch Curtis <mitch.curtis at qt.io>; development at qt-project.org
> > Subject: RE: Please add [ChangeLog] entries to your commits!
> > > -----Original Message-----
> > > From: Mitch Curtis
> > > Sent: Monday, May 29, 2017 3:27 PM
> > > To: Kai Koehne <Kai.Koehne at qt.io>; development at qt-project.org
> > > Subject: RE: Please add [ChangeLog] entries to your commits!
> > >
> > > > [...]
> > > > Please be reminded that all changes that might be of interest to the
> > > > end user should be part of the ChangeLog. So please, whenever
> > > > reviewing a change, please check whether a [ChangeLog] entry is in
> > order.
> > >
> > > Do we have a set of guidelines for what is considered interesting?
> > I'd say anything that changes observable behavior of existing features, or
> > new features.
> > Should get a [ChangeLog]
> > - new features
> > - fixes for bugs in released versions of Qt
> > Can be ignored:
> > - fixes in tests
> > - doc fixes
> > - pure code cleanup
> > - fixes for regressions introduced in not-yet-released commits
> > Regards
> > Kai
> > (who considers starting a QUIP about this ...)
> There's also this one:
> That doesn't mention anything about change log entries for non-critical
> bug fixes.
> Development mailing list
> Development at qt-project.org
More information about the Development