Skip to content

Instantly share code, notes, and snippets.

@mlzxy
Forked from Linell/.git-commit-template.txt
Last active August 29, 2015 14:27
Show Gist options
  • Save mlzxy/aaf2d55673cca1b7ec7e to your computer and use it in GitHub Desktop.
Save mlzxy/aaf2d55673cca1b7ec7e to your computer and use it in GitHub Desktop.
# <funtip><type> (<scope>): <subject>
# <body>
# <footer>
# FunTip
## Optional
## :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 Mac OS
## :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
## :lock: when dealing with security
## :arrow_up: when upgrading dependencies
## :arrow_down: when downgrading dependencies
## :shirt: when removing linter warnings
# Type
## Type should be one of the following:
## * feat (new feature)
## * fix (bug fix)
## * docs (changes to documentation)
## * style (formatting, missing semi colons, etc; no code change)
## * refactor (refactoring production code)
## * test (adding missing tests, refactoring tests; no production code change)
## * chore (updating grunt tasks etc; no production code change)
# Scope
## Scope is just the scope of the change. Something like (admin) or (teacher).
## Subject should use impertivite tone and say what you did.
## The body should go into detail about changes made.
## The footer should contain any JIRA (or other tool) issue references or actions.
# Subject and Body
## Use an imperative tone
## Subject be capitalized, short (50 chars or less) summary
# Footer
## Here's where we references items in our product management tool.
## Like:
## 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
##
## Or Like:
## ---------------------------------------------------------------------------------
## Issue Processing
## ISSUE_KEY #comment This is a comment
## ISSUE_KEY #done
## ---------------------------------------------------------------------------------
# For a full example of how to write a good commit message, check out
# https://github.com/sparkbox/how_to/tree/master/style/git
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment