Writing commits

History / Edit / PDF / EPUB / BIB /
Created: May 25, 2019 / Updated: November 2, 2024 / Status: draft / 1 min read (~85 words)
Software development Processes
  • One liner describing what changed (not period terminated)
  • A few lines describing in more details why things changed
  • GPG signed commit

  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Do not end the subject line with a period
  • Use the imperative mood in the subject line
  • Wrap the body at 72 characters
  • Use the body to explain what and why vs. how