git: Add commit template #11512
git: Add commit template #11512
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #11512 +/- ##
===========================================
+ Coverage 62.68% 83.11% +20.43%
===========================================
Files 840 909 +69
Lines 153669 257883 +104214
===========================================
+ Hits 96323 214346 +118023
+ Misses 57346 43537 -13809
Flags with carried forward coverage won't be shown. Click here to find out more. |
There was a problem hiding this comment.
When we get this approved, it would be good to add a version of what is this PR description in the commit session about contributing: https://docs.suricata.io/en/latest/devguide/contributing/code-submission-process.html#commits
jlucovsky
force-pushed
the
commit-template/1
branch
2 times, most recently
from
75001d9 to
f53a593
Compare
|
I like the idea, but I would expect the PR to contain a devguide update as well. It should explain how to use it. |
+1. I'd like to add that it should probably not live under |
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
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>
jlucovsky
force-pushed
the
commit-template/1
branch
from
f53a593 to
5054682
Compare
|
Continued in #12212 |
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
Describe changes:
Provide values to any of the below to override the defaults.
link to the pull request in the respective
_BRANCHvariable.SV_REPO=
SV_BRANCH=
SU_REPO=
SU_BRANCH=
LIBHTP_REPO=
LIBHTP_BRANCH=