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

Mitch Curtis mitch.curtis at qt.io
Wed May 31 14:30:41 CEST 2017


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

https://wiki.qt.io/Commit_Policy

That doesn't mention anything about change log entries for non-critical bug fixes.


More information about the Development mailing list