User:Jstanley/Changelog Draft

From FedoraProject

< User:Jstanley
Revision as of 06:18, 25 January 2010 by Jstanley (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Warning (medium size).png
This page is a draft only
It is still under construction and content may change. Do not rely on the information on this page.

Rationale

Package changelogs should be immutable. This is common sense, but is not codified in the guidelines currently

Proposal

Modify Packaging:Guidelines#Changelogs as below:


Every time you make changes, that is, whenever you increment the E-V-R of a package, add a changelog entry. This is important not only to have an idea about the history of a package, but also to enable users, fellow packages, and QA people to easily spot the changes that you make. You MUST NOT remove changelog entries once committed to source control. Exceptions are in cases of obvious error only - i.e. dates are incorrect, wrong e-v-r, etc.

If a particular change is related to a Bugzilla bug, include the bug ID in the changelog entry for easy reference, e.g.

* Wed Jun 14 2003 Joe Packager <joe at gmail.com> - 1.0-2
- Added README file (#42).

You must use one of the following formats:

* Fri Jun 23 2006 Jesse Keating <jkeating@redhat.com> - 0.6-4
- And fix the link syntax.
* Fri Jun 23 2006 Jesse Keating <jkeating@redhat.com> 0.6-4
- And fix the link syntax.
* Fri Jun 23 2006 Jesse Keating <jkeating@redhat.com>
- 0.6-4
- And fix the link syntax.