forked from OISF/suricata
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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>
- Loading branch information
Showing
2 changed files
with
7 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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." | ||
|