-
Notifications
You must be signed in to change notification settings - Fork 3
/
gitmessage
40 lines (31 loc) · 1.44 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
# <type>[optional scope]: <description> (Max 50 char)
# |<---- Using a Maximum Of 50 Characters ---->|
# [optional body] (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
# 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.
# Source https://www.conventionalcommits.org/
# --- 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
# 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
# --------------------
# Github Specifics
# Co-authored-by: name <name@example.com>
# Co-authored-by: another-name <github-username@users.noreply.github.com>