Skip to content

Commit

Permalink
git: Add commit template
Browse files Browse the repository at this point in the history
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
  • Loading branch information
jlucovsky committed Nov 19, 2024
1 parent 5d766df commit ddcc8d8
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions git-templates/commit-template.txt
Original file line number Diff line number Diff line change
@@ -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: <Redmine ticket number>

0 comments on commit ddcc8d8

Please sign in to comment.