Last active
October 21, 2017 16:25
-
-
Save mikkun/1df0561fc91c11b9250da37b86ac7974 to your computer and use it in GitHub Desktop.
Git commit message template to use Emoji Prefix
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# 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