Skip to content

Commit d369b09

Browse files
committed
Rephrase paragraphs regarding message formatting
Hopefully, this makes it clear that the 50-character rule refers to the first line of the commit (the "summary line") and not the whole message.
1 parent de3c2b5 commit d369b09

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,10 @@ request.
9494
in a single line which usually results in non-informative, ambiguous commit
9595
messages.
9696

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:
101101

102102
```shell
103103
# good - imperative present tense, capitalized, less than 50 characters
@@ -107,17 +107,17 @@ request.
107107
fixed ActiveModel::Errors deprecation messages failing when AR was used outside of Rails.
108108
```
109109

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.
113114

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):
117117

118118
```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
121121
Base products are marked obsolete when the NUMA hinting information is
122122
cleared but the same does not happen for huge records which this patch
123123
addresses.

0 commit comments

Comments
 (0)