From 39b10abf63b80516b0744d5a74698543e5cac008 Mon Sep 17 00:00:00 2001 From: rexagod Date: Sat, 8 Jun 2019 03:55:03 +0530 Subject: [PATCH] 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 --- doc/guides/contributing/pull-requests.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index fe4e9594f1496f..da0a8098db2121 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