-
-
Save Nitinrajyadav/b6e105ead4aaba8bce42766d11f01c86 to your computer and use it in GitHub Desktop.
This commit message template helps you write great commit messages and enforce it across teams.
This file contains 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
# <type>: (If applied, this commit will...) <subject> (Max 50 char) | |
# |<---- Using a Maximum Of 50 Characters ---->| | |
# Provide links to all related tasks | |
# Example: https://example.com/#/tasks/1234 | |
# Explain why this change is being made | |
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->| | |
# Provide links or keys to any other relevant issues, articles or other resources | |
# Example: Github issue #23 | |
# Example: https://vi.stackexchange.com/q/11892 | |
# --- COMMIT END --- | |
# Type can be | |
# feat (new feature) | |
# fix (bug fix) | |
# refactor (refactoring production code) | |
# style (formatting, missing semi colons, etc; no code change) | |
# docs (changes to documentation) | |
# test (adding or refactoring tests; no production code change) | |
# chore (updating grunt tasks etc; no production code change) | |
# -------------------- | |
# Remember to | |
# Capitalize the subject line | |
# Use the imperative mood in the subject line | |
# Do not end the subject line with a period | |
# Separate subject from body with a blank line | |
# Use the body to explain what and why vs. how | |
# Can use multiple lines with "-" for bullet points in body | |
# -------------------- | |
# ** Funtip ** | |
# Consider prefixing your commit messages with a relevant emoji | |
# :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 | |
# -------------------- | |
# For more information about this template, check out | |
# https://gist.github.com/nitinrajyadav/b6e105ead4aaba8bce42766d11f01c86 | |
# https://chris.beams.io/posts/git-commit/ | |
# all of this stuff is collected/coppied from different resources |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment