#17 consider expanding on changelog guidelines
Closed: Fixed None Opened 11 years ago by kevin.

Currently we have:

https://fedoraproject.org/wiki/Packaging/Guidelines#Changelog

Which talks about the formatting of changelog entries.
Would it be possible to consider guidelines/suggestions for content in the spec changelog, and possibly (in another place) for updates.

As a first cut to shout down:

Changelog entries in package spec files should contain changes made to the packageing (ie, spec file) itself. This would including noting updating to a new version, adding a patch, fixing other spec sections, note bugs fixed, and CVE's if any. This would not otherwise include changes made upstream by the project thats packaged.

Updates notes should contain links to upstream changelogs, notes about major user facing changes, and ways to test the update or links to tests.


I've made this into a draft:

https://fedoraproject.org/wiki/Changelogs_%28draft%29

I left out the part on updates notes (but added language so we can link to an external page) since the updates notes aren't really about packaging.. They're about Fedora processes.

Also note, someone else should champion this one since I don't think I agree with it. I use the rpm changelog to help me find out if a bug that I'm experiencing was introduced/fixed in recent (or not so recent) updates. I don't believe that I'm ever exposed to the update messages that are put into bodhi.

I was just hoping to open debate on this. ;)

I'll post to the list and gather more ideas.

Draft revised slightly in meeting, then approved. 6 +1, no 0, no -1

Wording that was agreed upon:

Changelog entries should provide a brief summary of the changes done to the package between releases, including noting updating to a new version, adding a patch, fixing other spec sections, note bugs fixed, and CVE's if any. They must never simply contain an entire copy of the source CHANGELOG entries. The intent is to give the user a hint as to what changed in a package update without overwhelming them with the technical details. Links to upstream changelogs can be entered for those who want additional information.

Metadata Update from @toshio:
- Issue assigned to spot

4 years ago

Login to comment on this ticket.

Metadata