From bfbbcf9d2736c66182381dbc542c28aeb4fac44e Mon Sep 17 00:00:00 2001 From: Anna Henningsen Date: Mon, 29 Aug 2016 21:47:09 +0200 Subject: [PATCH] doc: drop 50-character limit for commit messages Replace the current limit of 50 characters for the first line of the commit message with a more flexible formulation. --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c93bb6fc415f2..f1720a658c2530 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -92,11 +92,11 @@ $ git config --global user.email "j.random.user@example.com" 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 +1. The first line should be kept short and contain a concise description of the change prefixed with the name of the changed subsystem (e.g. "net: add localAddress and localPort to Socket"). 2. Keep the second line blank. -3. Wrap all other lines at 72 columns. +3. Wrap all lines at 72 columns. A good commit log can look something like this: