@@ -94,10 +94,10 @@ request.
94
94
in a single line which usually results in non-informative, ambiguous commit
95
95
messages.
96
96
97
- * The commit summary line should be * descriptive * yet * succinct * . It should be
98
- no longer than * 50 * characters . It should be capitalized and written in
99
- imperative present tense. If it is a single sentence, do not put a period at
100
- the end:
97
+ * The summary line (ie. the first line of the message) should be
98
+ * descriptive * yet * succinct * . It should be no longer than * 50 * characters.
99
+ It should be capitalized and written in imperative present tense.
100
+ Do not end the sentence with a period :
101
101
102
102
` ` ` shell
103
103
# good - imperative present tense, capitalized, less than 50 characters
@@ -107,17 +107,17 @@ request.
107
107
fixed ActiveModel::Errors deprecation messages failing when AR was used outside of Rails.
108
108
` ` `
109
109
110
- * The commit description should be wrapped to * 72* characters. It should
111
- describe the * problem* , * how* the patch solves it and any * side-effects* it
112
- might have.
110
+ * After the summary line, a blank line and then a more thorough description
111
+ should follow. It should be wrapped to * 72* characters and describe * why*
112
+ the change is needed, * how* it addresses the issue and any * side-effects*
113
+ it might have.
113
114
114
- It should be separated from the summary with a blank line. It should also
115
- provide any pointers to relevant resources (eg. link to a relevant record in
116
- a bug tracker):
115
+ It should also provide any pointers to related resources (eg. link to the
116
+ corresponding issue in a bug tracker):
117
117
118
118
` ` ` shell
119
- Mark huge records as obsolete when clearing hinting faults # <- summary
120
-
119
+ Mark huge records as obsolete when clearing hinting faults # <- summary line
120
+ # <- blank line
121
121
Base products are marked obsolete when the NUMA hinting information is
122
122
cleared but the same does not happen for huge records which this patch
123
123
addresses.
0 commit comments