1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: clarify commit message format in pull-requests.md

Browse Source 
Resolved ambiguous meanings for the term `body of commit message`
in `pull-requests.md` file,

Fixes: https://github.com/nodejs/node/issues/28068
PR-URL: https://github.com/nodejs/node/pull/28125
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
rexagod 2019-06-08 03:55:03 +05:30 committed by Rich Trott
parent 7e5e1c2515
commit 558f8349c3
1 changed files with 3 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/guides/contributing/pull-requests.md
View File

@ -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