Date: Thu, 14 Apr 2016 13:01:02 +0930 From: "O'Connor, Daniel" <darius@dons.net.au> To: Glen Barber <gjb@FreeBSD.org> Cc: Ngie Cooper <yaneurabeya@gmail.com>, FreeBSD Hackers <freebsd-hackers@freebsd.org> Subject: Re: Improving commit logs Message-ID: <1DDB0BFB-545F-4293-9BFB-020DAFD7A5C4@dons.net.au> In-Reply-To: <20160414032801.GP18163@FreeBSD.org> 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>
next in thread | previous in thread | raw e-mail | index | archive | help
> 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. 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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?1DDB0BFB-545F-4293-9BFB-020DAFD7A5C4>