-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathcommit
More file actions
19 lines (14 loc) · 1.51 KB
/
commit
File metadata and controls
19 lines (14 loc) · 1.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<title – If applied, this commit will ___________>
––––––––––––––––––––––––––––––––––––––––––––––––––|–––––––––––––––––––––
<body – explain WHAT was done and WHY it was implemented>
Describe why a change is being made.
How does it address the issue?
What effects does the patch have?
- Do not assume the reviewer understands what the original problem was.
- Do not assume the code is self-evident/self-documenting.
Read the commit message to see if it hints at improved code structure.
The first commit line is the most important.
––––––––––––––––––––––––––––––––––––––––––––––––––|–––––––––––––––––––––
––––––––––––––––––––––––––––––––––––––––––––––––––|–––––––––––––––––––––
––––––––––––––––––––––––––––––––––––––––––––––––––|–––––––––––––––––––––
––––––––––––––––––––––––––––––––––––––––––––––––––|–––––––––––––––––––––