/
.git_commit_template.txt
80 lines (74 loc) · 2.54 KB
/
.git_commit_template.txt
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
Add your title here
# See links to relevant web pages, issue trackers, blog articles, etc.
See: https://example.com/
See: [Example Page](https://example.com/)
# List all co-authors, so version control systems can connect teams.
Co-authored-by: Name <name@example.com>
Co-authored-by: Name <name@example.com>
# Why is this change happening, e.g. goals, use cases, stories, etc.?
Why:
# How is this change happening, e.g. implementations, algorithms, etc.?
How:
# Tags suitable for searching, such as hashtags, keywords, etc.
Tags:
# ## Help ##
#
# Subject line imperative uppercase verbs:
#
# Add = Create a capability e.g. feature, test, dependency.
# Drop = Delete a capability e.g. feature, test, dependency.
# Fix = Fix an issue e.g. bug, typo, accident, misstatement.
# Bump = Increase the version of something e.g. a dependency.
# Make = Change the build process, or tools, or infrastructure.
# Start = Begin doing something; e.g. enable a toggle, feature flag, etc.
# Stop = End doing something; e.g. disable a toggle, feature flag, etc.
# Optimize = A change that MUST be just about performance, e.g. speed up code.
# Document = A change that MUST be only in the documentation, e.g. help files.
# Refactor = A change that MUST be just refactoring.
# Reformat = A change that MUST be just format, e.g. indent line, trim space, etc.
# Rephrase = A change that MUST be just textual, e.g. edit a comment, doc, etc.
#
# For the subject line:
# * Use 50 characters maximum.
# * Do not use a sentence-ending period.
#
# For the body text:
# * Use as many lines as you like.
# * Use 72 characters maximum per line for typical word wrap text.
#
#
# ## About ##
#
# This is our team's starting point for our git commit messages.
# You can edit this template as you like, to customize it.
#
# For more information about git commit ideas and help:
# https://github.com/joelparkerhenderson/git_commit_message
#
#
# ## Usage ##
#
# Put the template file here:
#
# ~/.git_commit_template.txt
#
# Configure git to use the template file by running:
#
# git config --global commit.template ~/.git_commit_template.txt
#
# Add the template file to the ~/.gitconfig file:
#
# [commit]
# template = ~/.git_commit_template.txt
#
# If you prefer other file locations or ways of working,
# you can freely adjust the usage as you like.
#
#
# ## Tracking ##
#
# * Package: git_commit_message.txt
# * Version: 6.0.2
# * Updated: 2018-08-27T22:15:57Z
# * Licence: GNU General Public License (GPL-3.0)
# * Contact: Joel Parker Henderson (http://joelparkerhenderson.com)