Draft: simple update description guidelines

[Richard W.M. Jones]

On Wed, Jan 28, 2009 at 09:52:49AM +0000, Mark McLoughlin wrote:
> On Tue, 2009-01-27 at 23:48 +0530, Rahul Sundaram wrote:
> 
> >  * All Updates must refer to a upstream changelog or equivalent if one 
> > exists. Otherwise a brief description (a couple of sentence at most) 
> > justifying the need for an update must be provided by the maintainers 
> > pushing the update.
> > 
> > * If there are downstream bugs being fixed or intended to be fixed with 
> > an update, it must be referred within the update. Maintainers can choose 
> > to let bodhi auto close bugs or close it manually as well.
> > 
> > * For security update, add CVE information, if one exists.
> > 
> > * It is highly recommended that package maaintainers highlight major new 
> > features, critical bug fixes or anything else that has a potential high 
> > impact on consumers of your update.
> 
> I'd suggest the tone should be less prescriptive - i.e. not so much "you
> must do foo" - and also give some rationale.
> 
> e.g. "when preparing your update, consider what the user will see and
> how they will decide whether they should apply the update".

+1 to this.

Rich.

-- 
Richard Jones, Emerging Technologies, Red Hat  http://et.redhat.com/~rjones
Read my OCaml programming blog: http://camltastic.blogspot.com/
Fedora now supports 68 OCaml packages (the OPEN alternative to F#)
http://cocan.org/getting_started_with_ocaml_on_red_hat_and_fedora