This repository has been archived by the owner on Dec 8, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Add commit message template (#1)
- Loading branch information
1 parent
415337a
commit a3a5a46
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
|
||
# <Type>: <Subject text> # 50-char limit ######### | ||
# 72-character lines for description ################################### | ||
|
||
# Why: | ||
|
||
# Related Issues: | ||
|
||
# References: | ||
|
||
# Run git config commit.template .gitmessage | ||
# Use git commit when commiting files, and this template will be used. | ||
|
||
# Example commit message: | ||
# chore: Add commit message template | ||
|
||
# Captiolize subject line. | ||
# Write capitolized imperitive statement with no period for subject | ||
# List details of significant changes below the subject line | ||
# Write details as capitolized imperitive statements | ||
# Provide the below sections for further context | ||
|
||
# Why: | ||
|
||
# A short imperitve subject helps when viewing the log, especially when | ||
# viewing one-line formatted logs. Clear writing of what changed helps | ||
# give a clean understanding of context when reading blame messages and | ||
# when looking at a specific commit. | ||
|
||
# Related Issues: | ||
# Link to related issue numbers (hyper link if applicable), e.g.: | ||
# git issue 123 | ||
|
||
# References: | ||
# List relevant references e.g.: | ||
# https://chris.beams.io/posts/git-commit/ | ||
|
||
# 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) |