1e4218be6SOle Troan# <feature-name>: <subject>
2e4218be6SOle Troan# |<----  Using a maximum of 50 characters  ---->|
3e4218be6SOle Troan#
4e4218be6SOle Troan# Explain why this change is being made
5e4218be6SOle Troan# |<----   Try to limit each line to a maximum of 72 characters   ---->|
6e4218be6SOle Troan
7e4218be6SOle Troan# Ticket: <JIRA #id>
8e4218be6SOle Troan# Type: <type>
9e4218be6SOle Troan# Fixes: <offending-git-commit-id>
10e4218be6SOle Troan# Change-Id: <sha1>
11e4218be6SOle Troan# Signed-off-by: <email>
12e4218be6SOle Troan#
13e4218be6SOle Troan#
14e4218be6SOle Troan# --- COMMIT END ---
15e4218be6SOle Troan#
16e4218be6SOle Troan# Type can be
17574be8feSMohsin Kazmi#    feature     (new feature)
18574be8feSMohsin Kazmi#    fix         (bug fix)
19574be8feSMohsin Kazmi#    refactor    (refactoring production code)
20574be8feSMohsin Kazmi#    improvement (minor improvements in existing feature)
21574be8feSMohsin Kazmi#    style       (formatting, missing semi colons, etc; no code change)
22574be8feSMohsin Kazmi#    docs        (changes to documentation)
23574be8feSMohsin Kazmi#    test        (adding or refactoring tests; no production code change)
24574be8feSMohsin Kazmi#    make        (change the build process, or tools, or infrastructure)
25e4218be6SOle Troan#
26e4218be6SOle Troan# feature-name: Is the name of the VPP feature, plugin or directory.
27e4218be6SOle Troan#               Commits across multiple components should be split.
28e4218be6SOle Troan#               E.g. ip, fib, nat, acl, host, api
29e4218be6SOle Troan#
30e4218be6SOle Troan# Fixes: If type is fix refers to the original commit (optional).
31e4218be6SOle Troan# Ticket: Refers to JIRA ticket if it exists (optional).
32e4218be6SOle Troan#
33e4218be6SOle Troan# --------------------
34e4218be6SOle Troan# Remember to:
35e4218be6SOle Troan#    Lowercase the subject line.
36e4218be6SOle Troan#    Use the imperative mood in the subject line.
37e4218be6SOle Troan#    Not end the subject line with a period.
38e4218be6SOle Troan#    Separate subject from body with a blank line.
39e4218be6SOle Troan#    Use the body to explain what and why vs. how.
40e4218be6SOle Troan#    Use multiple lines with "-" for bullet points in body.
41e4218be6SOle Troan# --------------------
42e4218be6SOle Troan# Usage:
43e4218be6SOle Troan#
44e4218be6SOle Troan# The template is automatically added to the current repository by
45e4218be6SOle Troan# make install-dep.
46e4218be6SOle Troan# (git config commit.template .git_commit_template.txt)
47e4218be6SOle Troan#
48e4218be6SOle Troan# --------------------
49