.gitmessage

   1 [tag] subject
   2 # * Why was this change necessary?
   3 # * How does it address the problem?
   4 # * Are there any side effects?
   5
   6 * sub1
   7 - discription
   8
   9 # Include a link to the ticket.
  10 # <footer>
  11 # --- COMMIT END ---
  12 # Tag can be
  13 #    feat     (new feature)
  14 #    fix      (bug fix)
  15 #    refactor (refactoring code)
  16 #    style    (formatting, missing semi colons, etc; no code change)
  17 #    doc      (changes to documentation)
  18 #    test     (adding or refactoring tests; no production code change)
  19 #    version  (version bump/new release; no production code change)
  20 #    dbg      (Changes in debugging code/frameworks; no production code change)
  21 #    license  (Edits regarding licensing; no production code change)
  22 #    hack     (Temporary fix to make things move forward; please avoid it)
  23 #    defaults (changes default options)
  24 #
  25 # Remember to:
  26 #   * Capitalize the subject line
  27 #   * Use the imperative mood in the subject line
  28 #   * Do not end the subject line with a period
  29 #   * Separate subject from body with a blank line
  30 #   * Use the body to explain what and why vs. how
  31 #   * Can use multiple lines with "-" or "*" for bullet points in body