Date: Thu, 14 Apr 2016 03:48:05 +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: <20160414034805.GR18163@FreeBSD.org> In-Reply-To: <2FD1641C-DF99-4464-BA34-A05430D663C4@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> <20160414034320.GQ18163@FreeBSD.org> <2FD1641C-DF99-4464-BA34-A05430D663C4@dons.net.au>
next in thread | previous in thread | raw e-mail | index | archive | help
--MRBOAUz+O/XNC2GI Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thu, Apr 14, 2016 at 01:14:46PM +0930, O'Connor, Daniel wrote: >=20 > > On 14 Apr 2016, at 13:13, Glen Barber <gjb@FreeBSD.org> wrote: > > I absolutely agree with you that a guide on this will be beneficial. > > Sorry if my reply was taken any other way. > >=20 > > If I had a genie in a bottle, my three wishes would be: > >=20 > > 1) Better commit messages that address the "what"; > > 2) Better explanation on the "why"; >=20 > Huh interesting, I definitely would pick 2 before 1 but I can see > what you mean for a lot of commits (especially to 30 year old cruft > filled esoterica) >=20 When writing release notes, for example, the "what" is generally more useful than the "why." In other words, the end user does not generally care *why* something changed, but they want to know *what* changed. > > 3) More wishes. >=20 > You wish for more genies, wishing for more wishes is usually > verboten.. ;) >=20 I also want a pony. :) Glen --MRBOAUz+O/XNC2GI Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 iQIcBAEBCAAGBQJXDxL1AAoJEAMUWKVHj+KT75wP+QHT9pOHmOBlD2RSKILOf6tB 5/duvJ+rVBKp9A85Mqd4hNjYvfPPRtRZi7QeXjQw1E5FDIpIkYjNbJsZkI6QeIG6 LHX7COz4rgCjkWAz3fHahtR+SyGqr3LOzjv6ttumwrxeymjVHkBsEoCILDpyw+Z4 Xnu8n/zWzr7ehgBHgIlW7hcZVTfX2J3yEKJMEDqzqNQgq+rxZOe90Vo1tTeokOWS gugGYMjiAnZh3jywdJg11PV90NBIEE6rUNeZzuiVO/Myi+SMh6URjd393bjbtC+a VFgOPClP6HR7iIu6QdawrR5S2wjGI0K+vHIRADZSr7egKgjlHVlisYabBfiDbcq/ Prw0GIp5pp5FlRg/dKpBr17yM1gJHfc3j1h3Oq6dxWcWkInYbpNFgLFwVEqAB4Z1 6SKuzPKZN/2wYSC367QHpyzeFAaQsf88U3J8dQUB7AWLwUyU9KttXvYUM5RTY6Gy 1ytiJStMT/rwDf92yDOqr3m40E8GP5Pwz83VGeLIGa5lS+3lmZRDjTuP2aRfdzZW MYXvUkPcKlXqpQE9uy7CLHK+a4/7h2Pd28+LdZRzH+z9w3QkZ4V7l7mcKcxOdHMy yEojeLuZBmIQ+6Lu+M3ixWrg5ABaPTk3OaFk5O8+kfM/t3eKNR9kAUKPZrsgbIj2 DEZV/SolLRnRa9Iq0eAO =PlOL -----END PGP SIGNATURE----- --MRBOAUz+O/XNC2GI--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20160414034805.GR18163>