From owner-cvs-all  Mon Jul 26 16:35:19 1999
Delivered-To: cvs-all@freebsd.org
Received: from bubba.whistle.com (bubba.whistle.com [207.76.205.7])
	by hub.freebsd.org (Postfix) with ESMTP
	id D30A314E97; Mon, 26 Jul 1999 16:35:15 -0700 (PDT)
	(envelope-from archie@whistle.com)
Received: (from archie@localhost)
	by bubba.whistle.com (8.9.2/8.9.2) id QAA75551;
	Mon, 26 Jul 1999 16:32:40 -0700 (PDT)
From: Archie Cobbs <archie@whistle.com>
Message-Id: <199907262332.QAA75551@bubba.whistle.com>
Subject: Re: cvs commit: src/usr.bin/msgs msgs.1 msgs.c
In-Reply-To: <19990724175234.C13618@mad> from Tim Vanderhoek at "Jul 24, 99 05:52:34 pm"
To: vanderh@ecf.utoronto.ca (Tim Vanderhoek)
Date: Mon, 26 Jul 1999 16:32:40 -0700 (PDT)
Cc: nate@mt.sri.com, mjacob@FreeBSD.org, cvs-committers@FreeBSD.org,
	cvs-all@FreeBSD.org
X-Mailer: ELM [version 2.4ME+ PL38 (25)]
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Sender: owner-cvs-all@FreeBSD.ORG
Precedence: bulk

Tim Vanderhoek writes:
> In general, I think the average FreeBSD committer has a better style
> for writing commit messages than committers from other projects with
> closed CVS repos or that are just learning what a source repo is.
> 
> Things a good commit message contains,
> 
>  1) summary of the change
>  2) justification/reasoning
>  3) list of side effects
>  4) references (PRs, people, other commits, mail, etc).

I'd add: remember who the real target audience is. It's not the
freebsd-committers mailing list. It's some poor sod N years from
now trying to decipher what the hell happened way back in 1999.

That's why comments like "fennerism" and "brucify" are pretty useless..
soon nobody is going to remember who any of us were :-)

-Archie

___________________________________________________________________________
Archie Cobbs   *   Whistle Communications, Inc.  *   http://www.whistle.com


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message