Created
January 31, 2021 19:37
-
-
Save jserpapinto/5b7c9057b05d7340d8bdba8cdc4d94fc to your computer and use it in GitHub Desktop.
Git Commit Template - Conventional Commits
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
# If applied, this commit will... | |
# Why was this change made? | |
# Any more references to issues, articles, etc? | |
# --- COMMIT END --- | |
# Remember to: | |
# * Separate subject from body with a blank line | |
# * Limit the subject line to 50 characters | |
# * Capitalize the subject line | |
# * Do not end the subject line with a period | |
# * Use the imperative mood in the subject line | |
# * Wrap the body at 72 characters | |
# * Use the body to explain what and why vs. how | |
# | |
# -------------------- | |
# Type must be one of the following: | |
# build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | |
# ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | |
# docs: Documentation only changes | |
# feat: A new feature | |
# fix: A bug fix | |
# perf: A code change that improves performance | |
# refactor: A code change that neither fixes a bug nor adds a feature | |
# style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | |
# test: Adding missing tests or correcting existing tests | |
# | |
# -------------------- | |
# Commit Message Format | |
# Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject: | |
# | |
# <type>(<scope>): <subject> | |
# <BLANK LINE> | |
# <body> | |
# <BLANK LINE> | |
# <footer> | |
# | |
# -------------------- | |
# Revert: | |
# If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. | |
# In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment