-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy path.git-commit-template
44 lines (40 loc) · 1.65 KB
/
.git-commit-template
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
# <type>[optional scope]: <subject>
# |<---- Using a Maximum Of 50 Characters ---->|
# [optional body]
# |<---- Try To Limit Each Line to a Maximum of 72 Characters ---->|
# [optional references]
# [Optional Footer]
#
#
# --- 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)
# perf (code change that improves performance)
# --------------------
# - Type and subject are required, all else is optional
# - Scope can be used to define a subsection of the project
# - this should be defined by the project
# - References should denote tickets, articles or other resources
# - Example: Gitlab #23 or Hive #229
# - BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:,
# or appends a ! after the type/scope, introduces a breaking API change
# (correlating with MAJOR in semantic versioning).
# A BREAKING CHANGE can be part of commits of any type.
# --------------------
# Remember to
# - Capitalize the subject line
# - Use the imperative mood in the subject line
# - "Add dogs" (good) vs. "Added dogs" (bad)
# - 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
# --------------------
# Based off Conventional Commits:
# https://www.conventionalcommits.org