-
-
Save ricardo-dlc/d1d13b6319fc5c43282426b136e84d9e to your computer and use it in GitHub Desktop.
This commit message template that helps you write great commit messages and enforce it across your team.
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
# [<tag>] (If applied, this commit will...) <subject> (Max 72 char) | |
# |<---- Preferably using up to 50 chars --->|<------------------->| | |
# Example: | |
# [feat] Implement automated commit messages | |
# (Optional) Explain why this change is being made | |
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->| | |
# (Optional) Provide links or keys to any relevant tickets, articles or other resources | |
# Example: Github issue #23 | |
# --- COMMIT END --- | |
# Tag can be | |
# feat (new feature) | |
# fix (bug fix) | |
# refactor (refactoring code) | |
# style (formatting, missing semi colons, etc; no code change) | |
# doc (changes to documentation) | |
# test (adding or refactoring tests; no production code change) | |
# version (version bump/new release; no production code change) | |
# jsrXXX (Patches related to the implementation of jsrXXX, where XXX the JSR number) | |
# jdkX (Patches related to supporting jdkX as the host VM, where X the JDK version) | |
# dbg (Changes in debugging code/frameworks; no production code change) | |
# license (Edits regarding licensing; no production code change) | |
# hack (Temporary fix to make things move forward; please avoid it) | |
# WIP (Work In Progress; for intermediate commits to keep patches reasonably sized) | |
# defaults (changes default options) | |
# | |
# Note: Multiple tags can be combined, e.g. [fix][jsr292] Fix issue X with methodhandles | |
# -------------------- | |
# 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 "-" or "*" for bullet points in body | |
# -------------------- |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment