|
5 | 5 |
|
6 | 6 | ## Commits |
7 | 7 |
|
8 | | -* All commits should follow the [seven rules][git-seven-rules] of a [Git][git] commit message: |
| 8 | +All commits should follow the [seven rules][git-seven-rules] of a [Git][git] commit message: |
9 | 9 |
|
10 | | - 1. Use the [imperative mood][imperative-mood] in the [Git][git] commit subject line. |
| 10 | +1. Use the [imperative mood][imperative-mood] in the [Git][git] commit subject line. |
11 | 11 |
|
12 | | - ``` text |
13 | | - # Do not... |
14 | | - Fixed Markdown lint errors |
15 | | - ``` |
| 12 | + ``` text |
| 13 | + # Do not... |
| 14 | + Fixed Markdown lint errors |
| 15 | + ``` |
16 | 16 |
|
17 | | - ``` text |
18 | | - # Do... |
19 | | - Fix Markdown lint errors |
20 | | - ``` |
| 17 | + ``` text |
| 18 | + # Do... |
| 19 | + Fix Markdown lint errors |
| 20 | + ``` |
21 | 21 |
|
22 | | - 1. Capitalize the first word of the subject line. |
| 22 | +1. Capitalize the first word of the subject line. |
23 | 23 |
|
24 | | - ``` text |
25 | | - # Do not... |
26 | | - fix Markdown lint errors |
27 | | - ``` |
| 24 | + ``` text |
| 25 | + # Do not... |
| 26 | + fix Markdown lint errors |
| 27 | + ``` |
28 | 28 |
|
29 | | - ``` text |
30 | | - # Do... |
31 | | - Fix Markdown lint errors |
32 | | - ``` |
| 29 | + ``` text |
| 30 | + # Do... |
| 31 | + Fix Markdown lint errors |
| 32 | + ``` |
33 | 33 |
|
34 | | - 1. Do __not__ end the subject line with a period. |
| 34 | +1. Do __not__ end the subject line with a period. |
35 | 35 |
|
36 | | - ``` text |
37 | | - # Do not... |
38 | | - Fix Markdown lint errors. |
39 | | - ``` |
| 36 | + ``` text |
| 37 | + # Do not... |
| 38 | + Fix Markdown lint errors. |
| 39 | + ``` |
40 | 40 |
|
41 | | - ``` text |
42 | | - # Do... |
43 | | - Fix Markdown lint errors |
44 | | - ``` |
| 41 | + ``` text |
| 42 | + # Do... |
| 43 | + Fix Markdown lint errors |
| 44 | + ``` |
45 | 45 |
|
46 | | - 1. Separate the subject line from the body with a blank line. |
| 46 | +1. Separate the subject line from the body with a blank line. |
47 | 47 |
|
48 | | - ``` text |
49 | | - # Do not... |
50 | | - This is the subject line |
51 | | - This is the body body body body body body body body body body body body |
52 | | - body body body body body body body body body body body body body body |
53 | | - ``` |
| 48 | + ``` text |
| 49 | + # Do not... |
| 50 | + This is the subject line |
| 51 | + This is the body body body body body body body body body body body body |
| 52 | + body body body body body body body body body body body body body body |
| 53 | + ``` |
54 | 54 |
|
55 | | - ``` text |
56 | | - # Do... |
57 | | - This is the subject line |
| 55 | + ``` text |
| 56 | + # Do... |
| 57 | + This is the subject line |
58 | 58 |
|
59 | | - This is the body body body body body body body body body body body body |
60 | | - body body body body body body body body body body body body body body |
61 | | - ``` |
| 59 | + This is the body body body body body body body body body body body body |
| 60 | + body body body body body body body body body body body body body body |
| 61 | + ``` |
62 | 62 |
|
63 | | - 1. Try to limit the subject line to `50` characters. |
| 63 | +1. Try to limit the subject line to `50` characters. |
64 | 64 |
|
65 | | - ``` text |
66 | | - # Do not... |
67 | | - This is the subject line line line line line line line line line line line line line line |
68 | | - ``` |
| 65 | + ``` text |
| 66 | + # Do not... |
| 67 | + This is the subject line line line line line line line line line line line line line line |
| 68 | + ``` |
69 | 69 |
|
70 | | - ``` text |
71 | | - # Do... |
72 | | - This is the subject line |
73 | | - ``` |
| 70 | + ``` text |
| 71 | + # Do... |
| 72 | + This is the subject line |
| 73 | + ``` |
74 | 74 |
|
75 | | - 1. Use the body to explain the *what* and *why*, and not the *how*. |
| 75 | +1. Use the body to explain the *what* and *why*, and not the *how*. |
76 | 76 |
|
77 | | - ``` text |
78 | | - # Do not... |
79 | | - Change Markdown heading style |
| 77 | + ``` text |
| 78 | + # Do not... |
| 79 | + Change Markdown heading style |
80 | 80 |
|
81 | | - Update various Markdown files to stop lint errors. Change the heading |
82 | | - style from `===` to `#`. |
83 | | - ``` |
| 81 | + Update various Markdown files to stop lint errors. Change the heading |
| 82 | + style from `===` to `#`. |
| 83 | + ``` |
84 | 84 |
|
85 | | - ``` text |
86 | | - # Do... |
87 | | - Change Markdown heading style |
| 85 | + ``` text |
| 86 | + # Do... |
| 87 | + Change Markdown heading style |
88 | 88 |
|
89 | | - Change the heading style to ensure consistency with `remark` output. |
90 | | - This ensures that all Markdown files are all of the same style, thus |
91 | | - reducing the number of edge cases Markdown parsers need to consider. |
92 | | - ``` |
| 89 | + Change the heading style to ensure consistency with `remark` output. |
| 90 | + This ensures that all Markdown files are all of the same style, thus |
| 91 | + reducing the number of edge cases Markdown parsers need to consider. |
| 92 | + ``` |
93 | 93 |
|
94 | | - 1. Try to wrap the body at `72` characters. |
| 94 | +1. Try to wrap the body at `72` characters. |
95 | 95 |
|
96 | | - ``` text |
97 | | - # Do not... |
98 | | - This is the subject line |
| 96 | + ``` text |
| 97 | + # Do not... |
| 98 | + This is the subject line |
99 | 99 |
|
100 | | - This is the body body body body body body body body body body body body body body body body body body body body body body body body body body |
101 | | - ``` |
| 100 | + This is the body body body body body body body body body body body body body body body body body body body body body body body body body body |
| 101 | + ``` |
102 | 102 |
|
103 | | - ``` text |
104 | | - # Do... |
105 | | - This is the subject line |
| 103 | + ``` text |
| 104 | + # Do... |
| 105 | + This is the subject line |
106 | 106 |
|
107 | | - This is the body body body body body body body body body body body body |
108 | | - body body body body body body body body body body body body body body |
109 | | - ``` |
| 107 | + This is the body body body body body body body body body body body body |
| 108 | + body body body body body body body body body body body body body body |
| 109 | + ``` |
110 | 110 |
|
111 | 111 | --- |
112 | 112 |
|
|
0 commit comments