From owner-freebsd-hackers@freebsd.org Thu Apr 14 03:31:29 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 CD90AB0E7C2 for ; Thu, 14 Apr 2016 03:31:29 +0000 (UTC) (envelope-from yaneurabeya@gmail.com) Received: from mail-lf0-x22d.google.com (mail-lf0-x22d.google.com [IPv6:2a00:1450:4010:c07::22d]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (Client CN "smtp.gmail.com", Issuer "Google Internet Authority G2" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 6F38812C5; Thu, 14 Apr 2016 03:31:29 +0000 (UTC) (envelope-from yaneurabeya@gmail.com) Received: by mail-lf0-x22d.google.com with SMTP id g184so93864369lfb.3; Wed, 13 Apr 2016 20:31:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc; bh=lCGKV4tDB8wsOfAc5dJDfJWgfayiypviiOWuOz/icVQ=; b=H18ArMHArj12CGtH+J574wKrRMKHlt45HYsPfFn08Z3UxYJTLo2Zi2JbqZOQ5b6+yx iHImYLK6FjtTyeTmLIv1eC3a9HfsNAR9KMF/St73EOak27tzaLay6ufABnx+RNCIP+mM +Z+80/E3DTG7XMM4NHxaDJsB2yc4xFvK2nVRilYSlOThcKvUTXTBjy2ryCLDfXLcK708 QYJsedxg4uEd+wm3ytE4TjWHgHkLzYzs3+riM+3zC9SZVoF2dOI6GCI+bC2eavG096BD B5IOcWxOfd2Bn0gcqPfIaZRkjeSi5myRRuI6r5UCAq6HfqgWP6SGgj5f/3lj4eN6hs4n JMUA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:in-reply-to:references:date :message-id:subject:from:to:cc; bh=lCGKV4tDB8wsOfAc5dJDfJWgfayiypviiOWuOz/icVQ=; b=UDpu7LkQdbbgcxbJfDLG54gTCYphhLCqVJNYS3rg55vk8ppO79sNj4tDdJuQUQDNwO nbnwF4Dmf2LgGoZ7zh+zcfORoc/GJfVnSvwQXQTsFNZWy0pcOHUJ9fK0KP8kCSwJ6EHl uWj1Lw66O++RJKnso3ICs/EdhdU7g9qG9TtD/Wwy2/n5D4icN/7LxGU4BydbLWIY6O5/ /KZuVlVrsHZNeAdTpkmjadd2D6trUWNg60/nWd8RGCalomovhfL4Uifi3L2RKbOjcTmY HI5GS2MKIQvondH9F4sQ8WFBri6XssdnWab3EBjrcKpgHiJhTMu+ubDwkhYwIHbj+Bg/ wELA== X-Gm-Message-State: AOPr4FUx1sZqQWitlHosT9/7Y/5UjMPwGuAD0w8ESNMPZMlxFnbf9B9DGZyrEm0yBI+SEfBENXEDZ4jH0KDvlA== MIME-Version: 1.0 X-Received: by 10.112.52.196 with SMTP id v4mr4819346lbo.59.1460604687440; Wed, 13 Apr 2016 20:31:27 -0700 (PDT) Received: by 10.112.236.33 with HTTP; Wed, 13 Apr 2016 20:31:27 -0700 (PDT) In-Reply-To: <20160414032801.GP18163@FreeBSD.org> References: <56FF6534-276E-4E52-871F-5567BD9D6EC7@dons.net.au> <20160414032801.GP18163@FreeBSD.org> Date: Wed, 13 Apr 2016 20:31:27 -0700 Message-ID: Subject: Re: Improving commit logs From: Ngie Cooper To: Glen Barber Cc: "O'Connor, Daniel" , FreeBSD Hackers Content-Type: text/plain; charset=UTF-8 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:29 -0000 On Wed, Apr 13, 2016 at 8:28 PM, Glen Barber wrote: > On Thu, Apr 14, 2016 at 12:50:07PM +0930, O'Connor, Daniel wrote: >> >> > On 14 Apr 2016, at 12:28, Ngie Cooper wrote: >> >> Does anyone have any (constructive) comments or feedback? >> > >> > Isn't this just an extension of what others have written up before? >> > Googling "writing good commit messages yielded: >> > >> > 1. http://chris.beams.io/posts/git-commit/ >> > 2. https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message >> > >> > This is what I generally try to follow with commits... >> >> 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. Good point: usefulness is in the eye of the beholder. What's good for me to know might be completely irrelevant for someone else.. I guess this is where it helps to get CRs from people who aren't SMEs in the area that you need feedback with.. -Ngie