GIT Comment Template

.gitcommittemplate

#  Following the conventional commits spec
#  Please enter the commit message for your changes. Lines starting
#  with '#' will be ignored, and an empty message aborts the commit.
#
#  First line MUST be 50 characters or less
#  All lines after the first MUST be wrapped at 72 characters
#
# ==[ Subject: <type>(<scope>): <subject> ]======|
#    - 50 characters or less
#    - Optionally prefix with a relevant emoji (see below)
# ==[ Blank: Leave a blank line after the subject ]====================|
# ==[ Details: Describe what changed and why, wrapped at 72 chars ]====|
# ==[ Blank: Leave a blank line after details ]========================|
# ==[ Footer: References, breaking changes, etc. ]=====================|
#
# ** TYPES **
# feat: A new feature
# fix: A bug fix
# test: Adding missing tests or correcting existing tests
# chore: Updating dev-related maintenance files ("non-production code" files)
# wip: Work in progress feature branch
# revert: Revert to a commit
# style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
# ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
# docs: Documentation only changes
# perf: A code change that improves performance
# refactor: A code change that neither fixes a bug nor adds a feature
#
# ** SCOPE **
# The scope could be anything specifying place of the commit change. 
# For example:
# init
# runner
# watcher
# config
# web-server
# proxy
# etc.
#
# ** FOOTERS **
# References #1, #4, and #2.
# Fix #1. note this marks the item as accepted in Sprintly
# Closes #1 and #2. note this marks the item as accepted in Sprintly
# BREAKING CHANGE: <description of the breaking change>
#
# ** Fun tip **
# Work hard, play hard!  Consider prefixing your commit messages with a relevant emoji for 
# great good:
#
#   :art: `:art:` when improving the format/structure of the code
#   :racehorse: `:racehorse:` when improving performance
#   :non-potable_water: `:non-potable_water:` when plugging memory leaks
#   :memo: `:memo:` when writing docs
#   :penguin: `:penguin:` when fixing something on Linux
#   :apple: `:apple:` when fixing something on Mac OS
#   :checkered_flag: `:checkered_flag:` when fixing something on Windows
#   :bug: `:bug:` when fixing a bug
#   :fire: `:fire:` when removing code or files
#   :green_heart: `:green_heart:` when fixing the CI build
#   :white_check_mark: `:white_check_mark:` when adding tests
#   :lock: `:lock:` when dealing with security
#   :arrow_up: `:arrow_up:` when upgrading dependencies
#   :arrow_down: `:arrow_down:` when downgrading dependencies
#   :shirt: `:shirt:` when removing linter warnings
#   :champagne: `:champagne:` when celebrating a successful build
#   :tada: `:tada:` when adding a new feature
#   :fireworks: `:fireworks:` when removing code or files

Put together from various sources.