From owner-freebsd-hackers@freebsd.org Thu Apr 14 03:31:02 2016 Return-Path: Delivered-To: freebsd-hackers@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 56D6DB0E752 for ; Thu, 14 Apr 2016 03:31:02 +0000 (UTC) (envelope-from darius@dons.net.au) Received: from ipmail04.adl6.internode.on.net (ipmail04.adl6.internode.on.net [150.101.137.141]) by mx1.freebsd.org (Postfix) with ESMTP id AAD7E116F; Thu, 14 Apr 2016 03:31:01 +0000 (UTC) (envelope-from darius@dons.net.au) Received: from ppp14-2-34-252.lns21.adl2.internode.on.net (HELO midget.dons.net.au) ([14.2.34.252]) by ipmail04.adl6.internode.on.net with ESMTP; 14 Apr 2016 13:01:00 +0930 Received: from [10.0.2.26] ([10.0.2.26]) (authenticated bits=0) by midget.dons.net.au (8.15.1/8.14.9) with ESMTPSA id u3E3Usch034174 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Thu, 14 Apr 2016 13:00:59 +0930 (CST) (envelope-from darius@dons.net.au) Subject: Re: Improving commit logs Mime-Version: 1.0 (Mac OS X Mail 9.3 \(3124\)) Content-Type: text/plain; charset=us-ascii From: "O'Connor, Daniel" In-Reply-To: <20160414032801.GP18163@FreeBSD.org> Date: Thu, 14 Apr 2016 13:01:02 +0930 Cc: Ngie Cooper , FreeBSD Hackers Content-Transfer-Encoding: quoted-printable Message-Id: <1DDB0BFB-545F-4293-9BFB-020DAFD7A5C4@dons.net.au> References: <56FF6534-276E-4E52-871F-5567BD9D6EC7@dons.net.au> <20160414032801.GP18163@FreeBSD.org> To: Glen Barber X-Mailer: Apple Mail (2.3124) X-Spam-Score: -2.9 () ALL_TRUSTED,BAYES_00 X-Scanned-By: MIMEDefang 2.75 on 10.0.2.1 X-BeenThere: freebsd-hackers@freebsd.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: Technical Discussions relating to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 14 Apr 2016 03:31:02 -0000 > On 14 Apr 2016, at 12:58, Glen Barber wrote: >> Sure, but I think it carries more weight if you can point to a >> specific FreeBSD document and say "do it like this". > As one of the people that has to suffer through delving through commit > logs to find the 'gems', I can personally guarantee that documenting > "how to write good commit messages" will be less than fruitful. Realistically I don't see this as a magic bullet. IMO the only way to = enforce good commits is socially - i.e. have other committers call = people out on bad commit messages in a *constructive* way. That is to = say, you don't say "your commit message sucks" you say "I think it would = be helpful if the log explained why this change was made". I think having a document like this is useful as something to point to = and a guide for new committers to start from. -- Daniel O'Connor "The nice thing about standards is that there are so many of them to choose from." -- Andrew Tanenbaum GPG Fingerprint - 5596 B766 97C0 0E94 4347 295E E593 DC20 7B3F CE8C