From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Stephen Leake Newsgroups: gmane.emacs.devel Subject: Re: Your commit 7409a79 Date: Sat, 06 Dec 2014 16:33:47 -0600 Message-ID: <85k324h0hg.fsf@stephe-leake.org> References: <83h9x917il.fsf@gnu.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1417905263 6275 80.91.229.3 (6 Dec 2014 22:34:23 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 6 Dec 2014 22:34:23 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Dec 06 23:34:16 2014 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1XxNvb-0001Jm-9o for ged-emacs-devel@m.gmane.org; Sat, 06 Dec 2014 23:34:15 +0100 Original-Received: from localhost ([::1]:55791 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XxNva-0004aj-Ia for ged-emacs-devel@m.gmane.org; Sat, 06 Dec 2014 17:34:14 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:37380) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XxNvI-0004ac-WC for emacs-devel@gnu.org; Sat, 06 Dec 2014 17:34:02 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XxNvD-0003Gx-Ju for emacs-devel@gnu.org; Sat, 06 Dec 2014 17:33:56 -0500 Original-Received: from dnvrco-outbound-snat.email.rr.com ([107.14.73.229]:56634 helo=dnvrco-oedge-vip.email.rr.com) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XxNvD-0003Gt-Ei for emacs-devel@gnu.org; Sat, 06 Dec 2014 17:33:51 -0500 Original-Received: from [70.94.38.149] ([70.94.38.149:52877] helo=TAKVER) by dnvrco-oedge02 (envelope-from ) (ecelerity 3.5.0.35861 r(Momo-dev:tip)) with ESMTP id BC/5F-05421-E4483845; Sat, 06 Dec 2014 22:33:50 +0000 User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.94 (windows-nt) X-RR-Connecting-IP: 107.14.64.130:25 X-Authority-Analysis: v=2.1 cv=NtdfcqtJ c=1 sm=1 tr=0 a=AppmJ/7ZOOFWL/q6u6u93g==:117 a=AppmJ/7ZOOFWL/q6u6u93g==:17 a=ayC55rCoAAAA:8 a=fNEgcOh0sVsA:10 a=9i_RQKNPAAAA:8 a=mDV3o1hIAAAA:8 a=pryj9ZphxdLctcmkMYwA:9 a=lLcIXvqhIe8A:10 X-Cloudmark-Score: 0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 107.14.73.229 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:179218 Archived-At: Eli Zaretskii writes: > commit 7409a79b1b2acf1229dd763f5eb7b96abc17113a > Author: Stephen Leake > Date: Fri Dec 5 13:13:55 2014 -0600 > > preparing for further changes/cleanup to developers/contributors docs > > * etc/CONTRIBUTE: renamed to ./CONTRIBUTE, > > Please always start the commit log summary line with a capital letter, > and end the sentence with a period. Do we really need to be so picky? I agree there should be no comma here; that makes it an incomplete statement. But I don't think capitals and periods actually improve readability in this context; it's _not_ a manual, nor a code comment. Note that the Gnu coding standard does _not_ discuss this level of detail, although all the examples do have capitals and periods (http://www.gnu.org/prep/standards/html_node/Change-Logs.html#Change-Logs). I see this pickiness as a mild barrier to contributing, so I'd like to get some more rationale before I add this to CONTRIBUTE. And then I'll have to write some elisp to do that level of formatting (if someone hasn't already). > (Actually, in the above > particular case the summary line is redundant and could be omitted -- > but this is a stylistic comment, not a requirement.) I tried that: * etc/CONTRIBUTE: renamed to ./CONTRIBUTE, preparing for further changes/cleanup to developers/contributors docs But that was rejected by the commit filter as being longer than 79 chars. I didn't want to just do: * etc/CONTRIBUTE: renamed to ./CONTRIBUTE since that doesn't say anything about _why_. > Also, renaming a file needs an entry in the target's ChangeLog, Yes, I messed up the commit process. I did edit ChangeLog, but then forgot to stage it (and no, I'm not using 'git commit -a'). It's in the next commit. I'll get there. > like this: > > * CONTRIBUTE: Renamed from etc/CONTRIBUTE. > > and it also should end with a period, not a comma. Yes, the comma was a cut-and-paste error from the first attempt. -- -- Stephe