Differences

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

--- dev:git [2024/07/08 17:08] – Adding clarification for bug numbers in commit messages. klussier
+++ 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. Although it is acceptable to omit the Launchpad bug number from commit messages while work is in progress, by pullrequest time, it should include this number 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