.git_commit_template.txt

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