From b3537dfd6e7aa80960eb8d13fbd582dbb0e50c81 Mon Sep 17 00:00:00 2001 From: Adam Williamson Date: Sep 28 2023 21:29:47 +0000 Subject: Change processing SOP: document when not to do release notes There are Changes which probably shouldn't have release notes, but the SOP just says to always create a release notes ticket. This attempts to explain when and how *not* to do that. Signed-off-by: Adam Williamson --- diff --git a/modules/ROOT/pages/pgm_guide/sop/changes-process.adoc b/modules/ROOT/pages/pgm_guide/sop/changes-process.adoc index a3cbae6..21cabc8 100644 --- a/modules/ROOT/pages/pgm_guide/sop/changes-process.adoc +++ b/modules/ROOT/pages/pgm_guide/sop/changes-process.adoc @@ -23,7 +23,7 @@ This lets the next meeting chair know to include an announcement of the decision .. Add yourself to the _cc_ field .. Set the bug to block the `FChanges` tracking bug .. Set the bug status to `ASSIGNED` -. Create a Release Notes issue with the https://pagure.io/fedora-docs/release-notes/new_issue?template=change[Change template]. +. When appropriate (see below), create a Release Notes issue with the https://pagure.io/fedora-docs/release-notes/new_issue?template=change[Change template]. .. Use `Change: ` as the issue title .. Replace `URL HERE` with the wiki URL .. Set the _Milestone_ appropriately @@ -44,6 +44,11 @@ In that case you should try and find an address for a Change owner that does exi TIP: If the Change involves creating a new Spin, send the owners the xref:releases::spins/creating.adoc[Creating a Spin docs]. Otherwise, the coordination with Websites et al will probably be overlooked. +RELEASE NOTES: most Changes should be considered for release notes, but sometimes this does not make sense. +When a Change will not result in any notable impact on end users that can comprehensibly be explained to them, a release note is not necessary. +An example of such a Change is https://fedoraproject.org/wiki/Changes/PortingToModernC : this is a highly technical Change that is only of consequence and interest to Fedora maintainers, not end users. +When it does not make sense for a Change to have release notes, put "Release Notes tracker: N/A" in the "Current status" section of the Change page. + === Rejected proposals If a Change proposal is rejected by FESCo: