From 1b88f2189efc080d79f96e664203c9bcb0f5f626 Mon Sep 17 00:00:00 2001 From: Jeff Lucovsky Date: Tue, 16 Jul 2024 09:43:12 -0400 Subject: [PATCH] git: Add commit template Issue: none This commit adds a template that identifies commit message elements that we find important. The Suricata development team requests that contributions use the template to help improve commit messages. We reserve the right to strictly enforce adherence to the template in the future. Configure git to use this template with: git config commit.template ..github/commit-template.txt --- git-templates/commit-template.txt | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 git-templates/commit-template.txt diff --git a/git-templates/commit-template.txt b/git-templates/commit-template.txt new file mode 100644 index 0000000000..0f7b63431e --- /dev/null +++ b/git-templates/commit-template.txt @@ -0,0 +1,13 @@ +# Suricata commit template +# See https://docs.suricata.io/en/latest/devguide/contributing/code-submission-process.html +# Commit Title + +# Description +# Provide a description of the changes in this commit that +# gives the "why" for the change(s). Optionally, provide the +# actual changes (the "what"). +# - List main changes +# - List the motivation for each change +# - Optionally, include the specific changes + +Ticket: