Skip to content

Instantly share code, notes, and snippets.

@gprocell927

gprocell927/commit-etiquette.md

Created October 31, 2016 15:31
Show Gist options
  • Save gprocell927/34827d6c0a316879e34203e1428b4837 to your computer and use it in GitHub Desktop.
Save gprocell927/34827d6c0a316879e34203e1428b4837 to your computer and use it in GitHub Desktop.
Download ZIP
Proper Commit Message Etiquette
Raw
commit-etiquette.md

Rules For Proper Commit Messages

  1. Short, concise, descriptive messages.
  2. Written in imperative mode (uses "Fix", "Add", "Change")
  3. The first line should always be 50 characters or less and it should be followed by a blank line.
  4. Message states why the change was necessary, and what side effects it may have.

Examples of Good Messages

Fix failing ButtonTests Add tests for ImportSelector meta-data Fix typo in introduction to user guide Update Ruby on Rails version for security

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