diff options
author | rexagod <rexagod@gmail.com> | 2019-06-08 03:55:03 +0530 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2019-06-16 16:51:42 -0700 |
commit | 558f8349c3b08b382dbe622b304a610cd451b1c8 (patch) | |
tree | 1e423b8d42fc373487cf02d3b5077c7fbd632e44 /doc/guides | |
parent | 7e5e1c251526a1ee59071f0e312cb2da99454bda (diff) | |
download | android-node-v8-558f8349c3b08b382dbe622b304a610cd451b1c8.tar.gz android-node-v8-558f8349c3b08b382dbe622b304a610cd451b1c8.tar.bz2 android-node-v8-558f8349c3b08b382dbe622b304a610cd451b1c8.zip |
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: https://github.com/nodejs/node/issues/28068
PR-URL: https://github.com/nodejs/node/pull/28125
Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc/guides')
-rw-r--r-- | doc/guides/contributing/pull-requests.md | 11 |
1 files changed, 3 insertions, 8 deletions
diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index fe4e9594f1..da0a8098db 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -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 |