From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) by finch.gentoo.org (Postfix) with ESMTP id E0A6C1387FD for ; Fri, 28 Mar 2014 08:41:28 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 315B2E0A9D; Fri, 28 Mar 2014 08:41:25 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 9E5DEE0A9C for ; Fri, 28 Mar 2014 08:41:24 +0000 (UTC) Received: from hackintosh.gkp-asp.local (unknown [195.254.219.2]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) (Authenticated sender: bernalex) by smtp.gentoo.org (Postfix) with ESMTPSA id 2C66733FB91 for ; Fri, 28 Mar 2014 08:41:22 +0000 (UTC) From: Alexander Berntsen To: gentoo-portage-dev@lists.gentoo.org Subject: [gentoo-portage-dev] [PATCH] DEVELOPING: Add note on commit messages Date: Fri, 28 Mar 2014 09:41:18 +0100 Message-Id: <1395996078-24451-1-git-send-email-bernalex@gentoo.org> X-Mailer: git-send-email 1.8.3.2 In-Reply-To: <20140327124640.1b2b35fe.dolsen@gentoo.org> References: <20140327124640.1b2b35fe.dolsen@gentoo.org> Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-portage-dev@lists.gentoo.org Reply-to: gentoo-portage-dev@lists.gentoo.org X-Archives-Salt: 84160bc6-b640-4117-8331-17c32cfd9d9e X-Archives-Hash: b15b85ecce6a63702a36664e451b2b4b --- Following Brian and I having a chat yesterday, here's an update. It now uses "(bug 555555)" instead of "#555555", because of Willikins. DEVELOPING | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/DEVELOPING b/DEVELOPING index c6004ec..b2b0a19 100644 --- a/DEVELOPING +++ b/DEVELOPING @@ -175,6 +175,26 @@ change a lot of unrelated things. This makes it easier to see what parts of the system have actually changed. It also makes it easier to cherry-pick and revert commits. Use your commonsense! +Commit messages +--------------- + +Commit messages should be in the imperative mood with a capitalised +header, optionally followed by a newline and a more detailed explanatory +text. The headline should be capped at 50 characters, the detailed text +at 72. Prefix the message with the component you touched if this makes +sense. Postfix the message with the bug it fixes, if it does. Example: + +" +emerge: Fix --tree output (bug 555555) + +Make sure newlines appear where they are supposed to. Fix a bug with +colourisation of --tree output when used in tandem with --verbose +--pretend --ask. +" + +For a more detailed explanation (and rationalisation) of these rules: + + Releases -------- -- 1.8.3.2