git commit guidlines - sharmasadhna/mylearnings GitHub Wiki

Guideline for the commit message:

  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters (if possible, hard limit is 72)
    
  • Capitalize the subject line
    
  • Do not end the subject line with a period
    
  • Use the imperative mood in the subject line (means spoken or written as if giving a command or instruction)
    
  • Wrap the body at 72 characters
    
  • Use the body to explain what and why vs. how
    
  • For submodule changes add references to the corresponding changeID from submodule commit
    
  • Add references to issue trackers at the bottom