Skip to content

Commit 39b10ab

Browse files
rexagodtargos
authored andcommitted
doc: clarify commit message format in pull-requests.md
Resolved ambiguous meanings for the term `body of commit message` in `pull-requests.md` file, Fixes: #28068 PR-URL: #28125 Reviewed-By: Rich Trott <[email protected]>
1 parent 9edf695 commit 39b10ab

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

doc/guides/contributing/pull-requests.md

+3-8
Original file line numberDiff line numberDiff line change
@@ -176,14 +176,9 @@ Sample complete commit message:
176176
```txt
177177
subsystem: explain the commit in one line
178178
179-
Body of commit message is a few lines of text, explaining things
180-
in more detail, possibly giving some background about the issue
181-
being fixed, etc.
182-
183-
The body of the commit message can be several paragraphs, and
184-
please do proper word-wrap and keep columns shorter than about
185-
72 characters or so. That way, `git log` will show things
186-
nicely even when it is indented.
179+
The body of the commit message should be one or more paragraphs, explaining
180+
things in more detail. Please word-wrap to keep columns to 72 characters or
181+
less.
187182
188183
Fixes: https://github.com/nodejs/node/issues/1337
189184
Refs: http://eslint.org/docs/rules/space-in-parens.html

0 commit comments

Comments
 (0)