.commit-template

   1
   2
   3 # *************** OpenPilot commits guidelines ***************
   4 # Each commit needs to have a message like the following sample:
   5 #  OP-1150 UI for thermal calibration: Connect State machine to UI
   6 #
   7 # It needs to begin with a reference to one or more Jira tickets followed by a short description.
   8 # If needed add a longer description in the following lines, after an empty line.
   9 #
  10 # Before  committing, ensure your code is properly formatted using:
  11 #       make uncrustify_all
  12 # You can format flight or ground code only using respectively
  13 # uncrustify_flight or uncrustify_ground
  14 #
  15 # To automatically create a review, append the following smart commit messages:
  16 #   +review OPReview
  17 #
  18 # To append the commit to an existing review, use the following smart commit message:
  19 #   +review OPReview-NNN
  20 # For example "+review OPReview-609"
  21 #
  22 # *NOTE* leave an empty line between the commit message and "smart commit command"
  23 # Smart commits commands need to starts immediately at first column