Skip to content

Commit

Permalink
doc: clarify commit message format in pull-requests.md
Browse files Browse the repository at this point in the history
Resolved ambiguous meanings for the term `body of commit message`
in `pull-requests.md` file,

Fixes: #28068
PR-URL: #28125
Reviewed-By: Rich Trott <rtrott@gmail.com>
  • Loading branch information
rexagod authored and targos committed Jun 18, 2019
1 parent 9edf695 commit 39b10ab
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions doc/guides/contributing/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,14 +176,9 @@ Sample complete commit message:
```txt
subsystem: explain the commit in one line
Body of commit message is a few lines of text, explaining things
in more detail, possibly giving some background about the issue
being fixed, etc.
The body of the commit message can be several paragraphs, and
please do proper word-wrap and keep columns shorter than about
72 characters or so. That way, `git log` will show things
nicely even when it is indented.
The body of the commit message should be one or more paragraphs, explaining
things in more detail. Please word-wrap to keep columns to 72 characters or
less.
Fixes: https://github.com/nodejs/node/issues/1337
Refs: http://eslint.org/docs/rules/space-in-parens.html
Expand Down

0 comments on commit 39b10ab

Please sign in to comment.