Skip to content

Instantly share code, notes, and snippets.

@adeekshith
Forked from Linell/.git-commit-template.txt
Last active October 20, 2024 21:10
Show Gist options
  • Save adeekshith/cd4c95a064977cdc6c50 to your computer and use it in GitHub Desktop.
Save adeekshith/cd4c95a064977cdc6c50 to your computer and use it in GitHub Desktop.
This commit message template helps you write great commit messages and enforce it across teams.
# <type>: (If applied, this commit will...) <subject> (Max 50 char)
# |<---- Using a Maximum Of 50 Characters ---->|
# Explain why this change is being made
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# Provide links or keys to any relevant tickets, articles or other resources
# Example: Github issue #23
# --- 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
# --------------------
# For updated template, visit:
# https://gist.github.com/adeekshith/cd4c95a064977cdc6c50
# Licence CC
Copy link

ghost commented Jul 3, 2018

@sukima - see https://conventionalcommits.org/ for an explanation of the various types of commit. If you are using semver, many tools (lerna, for example) can automatically apply version updates based on git log messages since the last release.

@juanma386
Copy link

try in my server 🗡️

@romulogarofalo
Copy link

do you have the script to reject invalid commits?

@dardevelin
Copy link

@sukima type is particular useful in the context of a project that later can become a business. It helps with CAPEX (tech capitalisation) for tax purposes where you can deduct 'features' as investment and certain bugs as losses and so on.

@sukima
Copy link

sukima commented Sep 7, 2022

@sukima type is particular useful in the context of a project that later can become a business. It helps with CAPEX (tech capitalisation) for tax purposes where you can deduct 'features' as investment and certain bugs as losses and so on.

Huh, TIL. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment