Differences

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

--- dev:git [2024/01/09 15:54] – [Commit messages] stompro
+++ dev:git [2025/04/15 13:22] (current) – Include a section on commit template under Commit Guidelines stompro
@@ Line 40: / Line 40: @@
   git config user.email user@hostname
   git config user.name "Firstname Lastname"
+  #Enable the Evergreen default commit template
+  git config commit.template commit-template
   git checkout -b working_branch origin/main
@@ Line 66: / Line 69: @@
 ====== Guidelines for contributors ======
+===== Commit Template =====
+The Evergreen git repo includes an optional commit template that can be used to help follow standard project formatting.  [[https://git.evergreen-ils.org/?p=Evergreen.git;a=blob;f=commit-template;hb=HEAD|View the current main version of the template.]]
+Enable commit template:
+  git config commit.template commit-template
+Disable commit template:
+  git config --unset commit.template
 ===== Commit messages =====
-A commit message should consist of a subject line (i.e., the first line of the commit message), then a blank line, then an optional description of the patch, followed by one or more signoffs.  The subject line should be brief, ideally no more than 60-70 characters, and should include a bug number from LaunchPad if relevant.  Here is an example of a minimum commit message:
+A commit message should consist of a subject line (i.e., the first line of the commit message), then a blank line, then an optional description of the patch, followed by one or more signoffs.  The subject line should be brief, ideally no more than 60-70 characters. Although it is acceptable to omit the Launchpad bug number from commit messages while work is in progress, by pullrequest time, each commit in a branch should include this number if relevant.  Here is an example of a minimum commit message:
   LP#24544: fix the quuxifier
@@ Line 91: / Line 103: @@
   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 242: / Line 273: @@
   * Galen Charlton
-  * Thomas Berezansky
-  * Dan Scott
   * Jason Stephenson