diff options
| author |   Ole Troan <ot@cisco.com> | 2019-05-07 10:32:40 +0200 |
|---|---|---|
| committer |   Damjan Marion <dmarion@me.com> | 2019-05-29 09:03:24 +0000 |
| commit | e4218be67141311e8999059d7f848af4c2c311df (patch) | |
| tree | 155e63178c7caf6ff5ae76371a16aa22ad16f7de /.git_commit_template.txt | |
| parent | 11965c7b47670da7d02eb2c543be52008c66848e (diff) | |
make: git commit template
Add a commit template for tagging of commits
with a type. Later tooling can then process
the commit log and generate reports of new features
etc.
Usage:
The template is automatically added to the current repository
by make install-dep.
(git config commit.template .git_commit_template.txt)
Type: make
Change-Id: I485d61f9852b7390e4f0539d737ab210f7b0723a
Signed-off-by: Ole Troan <ot@cisco.com>
Diffstat (limited to '.git_commit_template.txt')
| -rw-r--r-- | .git_commit_template.txt | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/.git_commit_template.txt b/.git_commit_template.txt new file mode 100644 index 00000000000..d748e02e568 --- /dev/null +++ b/.git_commit_template.txt @@ -0,0 +1,47 @@ +# <feature-name>: <subject> +# |<---- Using a maximum of 50 characters ---->| +# +# Explain why this change is being made +# |<---- Try to limit each line to a maximum of 72 characters ---->| + +# Ticket: <JIRA #id> +# Type: <type> +# Fixes: <offending-git-commit-id> +# Change-Id: <sha1> +# Signed-off-by: <email> +# +# +# --- COMMIT END --- +# +# Type can be +# feature (new feature) +# fix (bug fix) +# refactor (refactoring production code) +# style (formatting, missing semi colons, etc; no code change) +# docs (changes to documentation) +# test (adding or refactoring tests; no production code change) +# make (change the build process, or tools, or infrastructure) +# +# feature-name: Is the name of the VPP feature, plugin or directory. +# Commits across multiple components should be split. +# E.g. ip, fib, nat, acl, host, api +# +# Fixes: If type is fix refers to the original commit (optional). +# Ticket: Refers to JIRA ticket if it exists (optional). +# +# -------------------- +# Remember to: +# Lowercase the subject line. +# Use the imperative mood in the subject line. +# Not end the subject line with a period. +# Separate subject from body with a blank line. +# Use the body to explain what and why vs. how. +# Use multiple lines with "-" for bullet points in body. +# -------------------- +# Usage: +# +# The template is automatically added to the current repository by +# make install-dep. +# (git config commit.template .git_commit_template.txt) +# +# -------------------- |