forked from openebs/openebs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
COMMIT_TEMPLATE
45 lines (35 loc) · 1.06 KB
/
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
45
# Short (50 chars or less) summary of change
# "If this commit is applied then this commit will XYZ"
# where *XYZ* is the 50 chars summary
# Detailed summary goes below in the form of an
# opinionated Q&A
# bullet points preferred over paragraphs
1. Why is this change necessary ?
# <should explain the change XYZ in more detail>
# Eg.
# - improves X by implementing feature A in B
# - reduces latency between P & Q
2. How does this change address the issue ?
# Eg.
# - mitigates case Y in Z machines.
# - avoids situation X by a code fix
3. How to verify this change ?
# <should be most detailed>
# Eg.
# - command Z does not give error and exits
# - this worked expectedly on X setup
# - verify the output of command Y which exits cleanly
4. What side effects does this change have ?
# Eg.
# - may/may not cause problem X while running Y
# - may/man not cause X to crash unexpectedly
5. Other details
# All PRs must have relevant issues
# for a
# - complete fix use *fix*
# - partial-fix use *improvement*
# Eg.
# fix: #1234
# improvement: #1234
# Size/*
# Host-OS: