Release notes for future versions

Frédéric Buclin lpsolit at
Fri Jan 16 18:10:01 UTC 2015

Le 16. 01. 15 11:49, Gervase Markham a écrit :
> We should keep the release notes in the docs/ folder as reST, and

I disagree. This requires to compile the docs to read them. I think it's
much easier to simply have an HTML page as we do currently.

> require the patch to contain a patch to the release notes if it's
> release-noteworthy. This means all the work is done at the time of patch
> submission.

I disagree here too. It's not the job of the contributor to decide what
should be relnoted and what shouldn't. And even if we say this should be
relnoted, it's not his job to follow our guidelines to document new
features. Also, some features require several bugs to be fully
implemented. It's much easier to relnote relevant information once the
whole feature is implemented. And so it's easier to do this after all
the related bugs have been fixed. And it's already hard enough to find
contributors, so please don't ask them to do more.

I made another proposal on IRC yesterday. The idea is to still add the
'relnote' keyword as we always did, but we update release notes for each
development release instead of waiting for rc1. The bug list between two
consecutive dev releases is not that big. And we have a better idea of
what is important and what is pretty minor.


More information about the developers mailing list