Skip to content

Instantly share code, notes, and snippets.

@gauravchl

gauravchl/commit.md

Created December 25, 2017 15:43
Show Gist options
  • Save gauravchl/2ad719edcc8e7888765d942ed3195ddc to your computer and use it in GitHub Desktop.
Save gauravchl/2ad719edcc8e7888765d942ed3195ddc to your computer and use it in GitHub Desktop.
Download ZIP
Git commit message spec
Raw
commit.md

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally
  • When only changing documentation, include [ci skip] in the commit description
  • Consider starting the commit message with an applicable emoji:
🎨 :art: when improving the format/structure of the code
🐎 :racehorse: when improving performance
🚱 :non-potable_water: when plugging memory leaks
📝 :memo: when writing docs
🐧 :penguin: when fixing something on Linux
🍎 :apple: when fixing something on macOS
🏁 :checkered_flag: when fixing something on Windows
🐛 :bug: when fixing a bug
🔥 :fire: when removing code or files
💚 :green_heart: when fixing the CI build
✅ :white_check_mark: when adding tests
🔒 :lock: when dealing with security
⬆️ :arrow_up: when upgrading dependencies
⬇️ :arrow_down: when downgrading dependencies
👕 :shirt: when removing l     inter warnings
✨ :sparkles: new feature
💄 :lipstick: Improve design, cosmetic
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment