From: Jeff Lucovsky <jlucovsky@oisf.net>
Date: Tue, 19 Nov 2024 14:30:23 +0000 (-0500)
Subject: doc/commit
X-Git-Tag: suricata-8.0.0-beta1~630
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=91d5b77316aa32f047de789a529ad3e992a4ecba;p=thirdparty%2Fsuricata.git

doc/commit

Describe how to use the git commit template. The template helps ensure
that the information needed for evaluation and context is included in
the commit message.

Ticket: <Redmine ticket number>
---

diff --git a/doc/userguide/devguide/contributing/code-submission-process.rst b/doc/userguide/devguide/contributing/code-submission-process.rst
index 05898ce319..78e50d3eeb 100644
--- a/doc/userguide/devguide/contributing/code-submission-process.rst
+++ b/doc/userguide/devguide/contributing/code-submission-process.rst
@@ -15,16 +15,20 @@ Commits
 #. If your code changes or adds new behavior, add the related documentation
    updates in their own commit, but make sure to add the same ticket number to
    both commit messages.
-#. Commit messages need to be properly formatted (check the example further
-     below in this section):
+#. Commit messages need to be properly formatted (check the example further below in this section).
       * Meaningful and short (50 chars max) subject line followed by an empty line
       * Naming convention: prefix message with sub-system (**"rule parsing: fixing foobar"**). If
         you're not sure what to use, look at past commits to the file(s) in your PR.
       * Description, wrapped at ~72 characters
 #. Commits should be individually compilable, starting with the oldest commit. Make sure that
-     each commit can be built if it and the preceding commits in the PR are used.
+   each commit can be built if it and the preceding commits in the PR are used.
 #. Commits should be authored with the format: "FirstName LastName <name@example.com>"
 
+We recommend that you use git commit message template with the following command:
+``git config commit.template /path/to/suricata/git-template/commit-template.txt``
+The template lists items that help describe the context and include requisite information in
+the commit message. We reserve the right to strictly enforce the template in the future:
+
 Information that needs to be part of a commit (if applicable):
 
 #. Ticket it fixes. E.g. "Fixes Bug #123."