Thoughts on Release Notes

[Robert Collins]

On Thu, 2007-06-14 at 09:42 -0500, John Arbash Meinel wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
> 
> Martin Pool wrote:
> > I'd be ok to coallesce all the changes from the rcs with the final
> > result, so you see them together.  We could mark items that happened
> > after the first release candidate.
> > 
> > How about adding a couple of paragraphs of overall summary text after
> > the version heading but before the detailed items?
> > 
> > When releasing it is good to at least briefly look over all the NEWS
> > and adjust, clarify, reorder or remove anything that needs it.
> > 
> 
> It would be nice to see a summary of NEWS, which coalesces the different
> changes, etc.
> 
> Right now, I don't know that it is worth the effort, (I'd rather spend the hour
>  in bug triage/fixing a bug).
> 
> But I think that as we approach a 1.0 it might make more sense. Certainly NEWS
> is more like our ChangeLog (though 'bzr log --short' makes a pretty good change
> log, too).
> 
> It is always possible to have things in the (inverse?) pyramid style. Where you
> give a short summary, and then expand, and then expand, etc. So that however
> far someone reads, they get a little bit more detail about what is going on.
> And if we have someone who is good at that (Ian?) then by all means we should
> do so. I guessing that for me to write a good writeup would take a couple of
> hours. And whether that would be better spent elsewhere is a point of discussion.

Didn't we just rejigger our policy for this 2 releases back?

We used to put everything in one section. And there was consensus that
this was wrong and should make each release - each rc and the final - be
a different section.

I'm with John. Lets fix bugs.

-Rob
-- 
GPG key available at: <http://www.robertcollins.net/keys.txt>.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20070615/9e236375/attachment.pgp