From a00ae7580589f0fa22d2929e7be312e98a21d6dd Mon Sep 17 00:00:00 2001 From: Luigi Pinca Date: Thu, 15 Sep 2016 14:35:19 +0200 Subject: [PATCH] doc: improve documentation for commit subject line MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Specify that commit subject line must be made of only lowercase words and should start with an imperative verb. PR-URL: https://github.com/nodejs/node/pull/8546 Reviewed-By: James M Snell Reviewed-By: Rich Trott Reviewed-By: Gibson Fahnestock Reviewed-By: Michaël Zasso Reviewed-By: Ben Noordhuis Reviewed-By: Jeremiah Senkpiel --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c93bb6fc4..120fdeaf3b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -93,15 +93,19 @@ Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when writing one: 1. The first line should be 50 characters or less and contain a short - description of the change prefixed with the name of the changed - subsystem (e.g. "net: add localAddress and localPort to Socket"). + description of the change. All words in the description should be in + lowercase with the exception of proper nouns, acronyms, and the ones that + refer to code, like function/variable names. The description should + be prefixed with the name of the changed subsystem and start with an + imperative verb, for example, "net: add localAddress and localPort + to Socket". 2. Keep the second line blank. 3. Wrap all other lines at 72 columns. A good commit log can look something like this: ```txt -subsystem: explaining the commit in one line +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