Skip to content

Instantly share code, notes, and snippets.

@mikkun
Last active October 21, 2017 16:25
Show Gist options
  • Save mikkun/1df0561fc91c11b9250da37b86ac7974 to your computer and use it in GitHub Desktop.
Save mikkun/1df0561fc91c11b9250da37b86ac7974 to your computer and use it in GitHub Desktop.
Git commit message template to use Emoji Prefix
# The subject line
# The body of a commit message.
# Resolves: #123
# Git commit message template to use Emoji Prefix
# ===============================================
#
# Consider starting the commit message with an applicable emoji:
# --------------------------------------------------------------
#
# Source: https://github.com/atom/atom/blob/master/CONTRIBUTING.md
#
# * 🎨 :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
# * β™» :recycle: when refactoring (or moving around)
# * πŸ”’ :lock: when dealing with security
# * ⬆ :arrow_up: when upgrading dependencies
# * ⬇ :arrow_down: when downgrading dependencies
# * πŸ‘• :shirt: when removing linter warnings
# * πŸŽ‰ :tada: when committing the initial code to a repo
# * πŸ”– :bookmark: when tagging versions
# * ✨ :sparkles: when introducing new features
#
# The seven rules of a great git commit message:
# ----------------------------------------------
#
# Source: http://chris.beams.io/posts/git-commit/
#
# 1. Separate subject from body with a blank line
# 2. Limit the subject line to 50 characters
# 3. Capitalize the subject line
# 4. Do not end the subject line with a period
# 5. Use the imperative mood in the subject line
# 6. Wrap the body at 72 characters
# 7. Use the body to explain what and why vs. how
#
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment