Git Commit Message

All Git Commit Messages MUST meet this Text Format:

:emoji1: :emoji2: Subject
(Only One NewLine)
Message Body
(Only One NewLine)
Ref <###>

Rules

  1. Message Subject SHOULD Begin with at-least One Emoji(see below for list of Suggested Emojis).
  2. Message Summary SHOULD End with at-least One GitHub Issue/Phabricator Task ID Reference, Ex. Issue #27, Ref T27 or Ref T27, T56 or Fixes T8.
  3. Total Characters of the Subject Line MUST be Less than or Equal to 72 Chars Long.
  4. Use Valid MarkDown format in Message Body.
  5. Use the Present Tense ("Add feature" not "Added feature").
  6. Use the Imperative Mood ("Move cursor to..." not "Moves cursor to...").
  7. All WIP(Work In Progress) Commits MUST have the WIP Emoji(see below).

Notes

  • (IMPORTANT) All WIP Commits Should be Avoided!.
  • (NOTE) Tasks with Commits in Fixes T### Format will be Automatically Closed as Resolved!.
  • (WARNING) There is a Space Character between Multiple Emojis!.
  • (WARNING) There is NO New-Line After the Task ID Reference Line.
  • (NOTE) Every Raw Emoji Text(:emoji:) is Counted as One Char!.

Suggested Emojis

Emoji Raw Emoji Code Description
🎨 :art: when improving the format/structure of the code
🐎 :racehorse: when improving performance
📚 :books: when writing docs
🐛 :bug: when reporting a bug
🚑 :ambulance: when fixing a bug
🐧 :penguin: when fixing something on Linux
🍎 :apple: when fixing something on Mac OS
🏁 :checkered_flag: when fixing something on Windows
🔥 :fire: when removing code or files
:white_check_mark: when adding tests
💚 :green_heart: when fixing the CI build
🔒 :lock: when dealing with security
⬆️ :arrow_up: when upgrading dependencies
⬇️ :arrow_down: when downgrading dependencies
👕 :shirt: when removing linter/strict/deprecation warnings
💄 :lipstick: when improving UI/Cosmetic
🚧 :construction: WIP(Work In Progress) Commits
💎 :gem: New Release
🔖 :bookmark: Version Tags
🎉 :tada: Initial Commit
🔈 :speaker: when Adding Logging
🔇 :mute: when Reducing Logging
:sparkles: when introducing New Features
:zap: when introducing Backward-InCompatible Features
💡 :bulb: New Idea
❄️ :snowflake: changing Configuration, Usually together with 🐧 or 🎀 or 🚀
🎀 :ribbon: Customer requested application Customization
🚀 :rocket: Anything related to Deployments/DevOps

Ask to Be Creative!