forked from aws/amazon-freertos
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.gitmessage
48 lines (36 loc) · 1.65 KB
/
.gitmessage
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# <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 committing files, and this template will be used.
# Example commit message:
# chore: Add commit message template
# Capitalize subject line.
# Write capitalized imperative statement with no period for subject
# List details of significant changes below the subject line
# Write details as capitalized imperative statements
# Provide the below sections for further context
# Why:
# A short imperative 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
# chore (updating grunt tasks etc; no production code change)
# docs (changes to documentation, comments. No logic change)
# feat (New feature)
# fix (Bug fix, or other change related to tracked issue)
# merge (Merge of one branch into another, no other change)
# refactor (refactoring production code)
# revert (Revert of a previous commit, no other change)
# style (formatting, missing semi colons, etc; no code change)
# test (adding or refactoring tests; no production code change)
# tool (adding or refactoring tools; no production code change)