Differences

This shows you the differences between two versions of the page.

--- dev:git [2023/06/01 13:03] – master to main branch rename dyrcona
+++ dev:git [2024/04/09 13:17] (current) – [Bug Fix Release Note Commit Message Tag] stompro
@@ Line 71: / Line 71: @@
   LP#24544: fix the quuxifier
+  Release-Note: Fix the cromulent emulsification of the quuxifier for new installs.
   Signed-off-by: Jane Hacker <jhacker@example.org>
@@ Line 89: / Line 91: @@
   Signed-off-by: Roger Reviewer <roger@example.com>
   Signed-off-by: Chris Committer <chris@example.net>
+===== Bug Fix Release Note Commit Message Tag =====
+For simple bug fixes that can be described with one line, include a line that starts with "**Release-Note:**" that includes the release note text.  This will be grabbed by a script during release creation to speed up creating the release notes.
+==== Use Present Tense ====
+"**Release-Note:**" entries should use present tense; **Add**, **Adds**, **Fixes**, **Updates**, **Removes**.
+If the bug fix needs more explanation, then the docs/RELEASE_NOTES_NEXT/miscellaneous.adoc would be a better location to add those notes.
+Examples:
+  Release-Note: Adds form field labels for patron survey question administration
+  Release-Note: Fixes an issue where auto-renewal events can overwhelm open-ils.trigger drones
+===== Testing Plan =====
+Include a testing plan to ensure that any testers of your patch can quickly understand how to see the original problem and know how to confirm that the fix works.  If a specific system configuration needs to be setup to see the problem in a Concerto Evergreen install, then include those steps.
+It is also acceptable to include the testing plan in the Launchpad ticket, but a note in the commit message such as "See LP bug report for testing plan" can make sure the tester knows where to find it.
 ===== Sign-offs =====
@@ Line 240: / Line 261: @@
   * Galen Charlton
-  * Thomas Berezansky
-  * Dan Scott
   * Jason Stephenson