Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

git: Add commit template #12212

Closed
wants to merge 2 commits into from
Closed

git: Add commit template #12212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddcc8d8
git: Add commit template
jlucovsky Jul 16, 2024
4b253c3
doc/commit
jlucovsky Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions doc/userguide/devguide/contributing/code-submission-process.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>"

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."
Expand Down
13 changes: 13 additions & 0 deletions git-templates/commit-template.txt
View file
Open in desktop
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>
Loading