Date: Thu, 14 Apr 2016 03:43:20 +0000 From: Glen Barber <gjb@FreeBSD.org> To: "O'Connor, Daniel" <darius@dons.net.au> Cc: Ngie Cooper <yaneurabeya@gmail.com>, FreeBSD Hackers <freebsd-hackers@freebsd.org> Subject: Re: Improving commit logs Message-ID: <20160414034320.GQ18163@FreeBSD.org> In-Reply-To: <1DDB0BFB-545F-4293-9BFB-020DAFD7A5C4@dons.net.au> References: <56FF6534-276E-4E52-871F-5567BD9D6EC7@dons.net.au> <CAGHfRMAwZ-A7BspzCqAEniyQOcy1fmL85V4wjzG0gDBq6gbjtw@mail.gmail.com> <FBAA087E-DCF3-4FB7-922D-A333AD237A23@dons.net.au> <20160414032801.GP18163@FreeBSD.org> <1DDB0BFB-545F-4293-9BFB-020DAFD7A5C4@dons.net.au>
next in thread | previous in thread | raw e-mail | index | archive | help
--tk6xM/wkRlnXD2NA Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thu, Apr 14, 2016 at 01:01:02PM +0930, O'Connor, Daniel wrote: >=20 > > On 14 Apr 2016, at 12:58, Glen Barber <gjb@FreeBSD.org> 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. >=20 > 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". >=20 > I think having a document like this is useful as something to > point to and a guide for new committers to start from. >=20 I absolutely agree with you that a guide on this will be beneficial. Sorry if my reply was taken any other way. If I had a genie in a bottle, my three wishes would be: 1) Better commit messages that address the "what"; 2) Better explanation on the "why"; 3) More wishes. Glen --tk6xM/wkRlnXD2NA Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 iQIcBAEBCAAGBQJXDxHTAAoJEAMUWKVHj+KTAFcP+wdw0/Ox6/jPl2arPs4cyQ+R Y7sPWeadXrnQE3fQDi4gQHcLppTdXSwrQC6k3Hee/52C4oCNQ3a+0xgZRh3K3+vN Rl//zvHSfNuZ4VgRkICG/Vp1RXF3YlYSM7U1ehGiD27D41o2f6NJZcB28C8moBR5 lNSaPO5dotbAqWzhq5eruGqcFvw7+PWGx6JmWMLG8eqUuhHOCQFCWMOwod3coAtq qVv0NolStbzdZP5GIkt9vH2i211ISedSmHBxN1roq5mdsqGVKBYxAXZpQ3XbfVYF 65iqAQZzrVQUpflpkDS6U11ZAplCJrau0uvB15uL9XKwv3nu1VCT9D9uu7aNtmTy yqtbWZQ8/ubFAfCl1WZ4fiPknUL0kEAXoZUOKlJredJtRMYsbCqGRd0WsDO0NUkK dSjwxBeygEBl6S1d3HgmP+mZMabxTElDybC+7cYHKU6PNCE0Um1wflnegFXxVagh 6Jn313hck4yApmrW+kjSUzpeFQTZaVjmdU92BvLu3ogTPHHwc0KgF5x4BVJejdpT DaFzAAn0zgZ3/D0OR0kLBHt18Kddo9vwP5Zenjx3uSkWevPERpE+YrjNV0WNzDEh THBU/F13Fq9bKF5m/fJfqWLr0fP7rhNi4AGi6BRDi4VVNuuEdE7rPav1x0rbdsuU gQTkNxQevOyURLSoriRK =bD7O -----END PGP SIGNATURE----- --tk6xM/wkRlnXD2NA--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20160414034320.GQ18163>