From owner-freebsd-hackers@freebsd.org Thu Apr 14 03:28:04 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 263E7B0E4B4 for ; Thu, 14 Apr 2016 03:28:04 +0000 (UTC) (envelope-from gjb@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:1900:2254:206c::16:87]) by mx1.freebsd.org (Postfix) with ESMTP id 14EDA1E0C; Thu, 14 Apr 2016 03:28:04 +0000 (UTC) (envelope-from gjb@FreeBSD.org) Received: from FreeBSD.org (freefall.freebsd.org [IPv6:2001:1900:2254:206c::16:87]) by freefall.freebsd.org (Postfix) with ESMTP id BCD0E14CD; Thu, 14 Apr 2016 03:28:03 +0000 (UTC) (envelope-from gjb@FreeBSD.org) Date: Thu, 14 Apr 2016 03:28:01 +0000 From: Glen Barber To: "O'Connor, Daniel" Cc: Ngie Cooper , FreeBSD Hackers Subject: Re: Improving commit logs Message-ID: <20160414032801.GP18163@FreeBSD.org> References: <56FF6534-276E-4E52-871F-5567BD9D6EC7@dons.net.au> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="y6PvmTFIYclVmRST" Content-Disposition: inline In-Reply-To: X-Operating-System: FreeBSD 11.0-CURRENT amd64 X-SCUD-Definition: Sudden Completely Unexpected Dataloss X-SULE-Definition: Sudden Unexpected Learning Event X-PEKBAC-Definition: Problem Exists, Keyboard Between Admin/Computer User-Agent: Mutt/1.5.24 (2015-08-30) 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:28:04 -0000 --y6PvmTFIYclVmRST Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thu, Apr 14, 2016 at 12:50:07PM +0930, O'Connor, Daniel wrote: >=20 > > On 14 Apr 2016, at 12:28, Ngie Cooper wrote: > >> Does anyone have any (constructive) comments or feedback? > >=20 > > Isn't this just an extension of what others have written up before? > > Googling "writing good commit messages yielded: > >=20 > > 1. http://chris.beams.io/posts/git-commit/ > > 2. https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-mess= age > >=20 > > This is what I generally try to follow with commits... >=20 > Sure, but I think it carries more weight if you can point to a > specific FreeBSD document and say "do it like this". >=20 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. Glen --y6PvmTFIYclVmRST Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 iQIcBAEBCAAGBQJXDw5BAAoJEAMUWKVHj+KTGX0P/1Ur2QMaUR1b4VZ3gx/mpIaN MVACtqKetU0tiYF33Kn+3AncOeIQA1IH3sUoWxvM5BZlFGvdEQaDv47Gj5P9HMB6 qKIq3QYshExJ8HkryKwpKqkCASYM1l5DdvbedDT7ISeW8hTAYjOaMWnwvl6IUBKI vpfvbX0bqgoHxYXMtuWoQtxtZWXdyVIAOVVUlMM9dpxz12CQ9vaHJsEFFRmRD591 9/IvwKhs7h2nxrsCFLIKYut7sKqsf0GYlE58qk6NYnJafd42SauMP+LnI8oNZkZV fIuRJdSBCoVZIMyJEtIVEdV87kM1c4Q8hfGcSCa+NqQxnzhsi80fSwY49hqb6ryN FD/Y0+H5575FPZ52qU6MJKq9lJa37zuAVhpbbRUF3oWuCy2q0HOMkmKuqRhbpu3P zaYVNC+M11sKy/ABoluOx4oqtI50wRiWFledawsOW6d7/7IkcOm9KT550FFT4rbR WL/+PW9T7znvZDviGc4BdCvc232qdpoSmA8n2kP3ufpJNbX3CcbOOcUUOpTgyy/l rWLCAfHQzjC/SYigN72/LRvT37JocN1LcpocW+JLbL0EIMIhFw7ZsRDL62+jGFne YzYJtlx4gbOK//NitzJarMNWCQL+DTXO8R80X/GUJfHHV9wIcup7YpcSiSMXOU34 oxV1wctffSEZgmz7y+Rt =tkRZ -----END PGP SIGNATURE----- --y6PvmTFIYclVmRST--