Rumproarious - Notes - About

A good commit message

There will be commit messages. Many. Of. Them.

Your team will read them. Your boss will read them. Strangers will read them. You will read them.

Future self is skeptical of present self.

You owe it to everyone to try and write better commit messages.

I'm not suggesting that I always do, it's a lofty goal, but here is some help:

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

Please do read the whole post though.