Skip to content

Instantly share code, notes, and snippets.

@jcf
Created July 31, 2012 13:56
Show Gist options
  • Save jcf/3217226 to your computer and use it in GitHub Desktop.
Save jcf/3217226 to your computer and use it in GitHub Desktop.
Git Commit Style Guide

Writing Commit Messages

Structure your commit message like this:

One line summary (less than 50 characters)

Longer description (wrap at 72 characters)

Summary

  • Less than 50 characters
  • What was changed
  • Imperative present tense (fix, add, change)
    • Fix bug 123
    • Add 'foobar' command
    • Change default timeout to 123
  • No period

Description

  • Wrap at 72 characters
  • Why, explain intention and implementation approach
  • Present tense

Atomicity

  • Break up logical changes
  • Make whitespace changes separately
@haneenmahd
Copy link

Nice 👌 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment