Skip to content

Instantly share code, notes, and snippets.

@ahmadawais
Last active May 5, 2018 16:29
Show Gist options
  • Save ahmadawais/815ea20134cf4616a6b2a965eb08f716 to your computer and use it in GitHub Desktop.
Save ahmadawais/815ea20134cf4616a6b2a965eb08f716 to your computer and use it in GitHub Desktop.
AA Git Commit Log

Emoji Log by Ahmad Awais

After producing hundreds of open source software I've ended up inventing a git commit messaging that I really like.

I'd try a write more about it in a up coming blog post but here's the gist.

image

RULES

  • Make your Git commit messages imperitive (E.g. Add this, instead of Added this)
  • Use the following syntax and nothing expect that, this will make the commit instantly recognizable
  • Use a git software like VS Code to commit git messages with the right files

image

Allowed Git Commit Messages

πŸ“¦ NEW: IMPERITIVE_MESSAGE_GOES_HERE β†’ Use it when you add something completly new.

πŸ‘Œ IMPROVE: IMPERITIVE_MESSAGE_GOES_HERE β†’ Use it when you improve or enhance some piece of code like refactoring etc.

πŸ› FIX: IMPERITIVE_MESSAGE_GOES_HERE β†’ Use this when you fix a bug β€” need I say more?

πŸ“– DOC: IMPERITIVE_MESSAGE_GOES_HERE β†’ Use this when you add documentation like readme.md, or even inline docs.

πŸš€ RELEASE: IMPERITIVE_MESSAGE_GOES_HERE β†’ Use this when you release a new version.

That's it for now.

The create-guten-block repo git log is a live example of how it looks. Check it out.

@ahmadawais
Copy link
Author

This is a Work-In-Progress Emoji-spec for commit logs.

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