From: Stephen Leake <stephen_leake@stephe-leake.org>
To: emacs-devel@gnu.org
Subject: Re: Your commit 7409a79
Date: Sat, 06 Dec 2014 16:33:47 -0600 [thread overview]
Message-ID: <85k324h0hg.fsf@stephe-leake.org> (raw)
In-Reply-To: 83h9x917il.fsf@gnu.org
Eli Zaretskii <eliz@gnu.org> writes:
> commit 7409a79b1b2acf1229dd763f5eb7b96abc17113a
> Author: Stephen Leake <stephen_leake@stephe-leake.org>
> 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
next prev parent reply other threads:[~2014-12-06 22:33 UTC|newest]
Thread overview: 52+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-12-06 8:56 Your commit 7409a79 Eli Zaretskii
2014-12-06 10:22 ` Andreas Schwab
2014-12-06 10:29 ` Eli Zaretskii
2014-12-06 10:32 ` Paul Eggert
2014-12-06 15:29 ` Yuri Khan
2014-12-06 23:01 ` Stefan Monnier
2014-12-06 16:14 ` Tom
2014-12-06 18:54 ` Eli Zaretskii
2014-12-06 22:43 ` Stephen Leake
2014-12-06 22:33 ` Stephen Leake [this message]
2014-12-07 3:52 ` Eli Zaretskii
2014-12-07 22:39 ` Stephen Leake
2014-12-08 1:57 ` Paul Eggert
2014-12-08 2:28 ` Stephen J. Turnbull
2014-12-08 15:58 ` Eli Zaretskii
2014-12-08 23:38 ` Stephen Leake
2014-12-08 15:58 ` Eli Zaretskii
2014-12-08 18:24 ` Paul Eggert
2014-12-08 15:51 ` Eli Zaretskii
2014-12-08 17:32 ` John Yates
2014-12-08 17:57 ` Eli Zaretskii
2014-12-08 18:14 ` Paul Eggert
2014-12-08 18:28 ` Eli Zaretskii
2014-12-08 18:37 ` Eli Zaretskii
2014-12-08 18:54 ` Paul Eggert
2014-12-08 19:00 ` Stefan Monnier
2014-12-08 18:54 ` John Yates
2014-12-08 23:27 ` Stephen Leake
2014-12-09 0:51 ` Thien-Thi Nguyen
2014-12-09 8:08 ` Stephen Leake
2014-12-09 9:36 ` Thien-Thi Nguyen
2014-12-09 16:57 ` Eli Zaretskii
2014-12-10 9:26 ` Stephen Leake
2014-12-10 16:17 ` Eli Zaretskii
2014-12-10 17:04 ` Stephen Leake
2014-12-10 18:02 ` Eli Zaretskii
2014-12-10 19:20 ` Paul Eggert
2014-12-07 5:45 ` Stephen J. Turnbull
2014-12-06 22:59 ` Stefan Monnier
2014-12-07 22:44 ` Stephen Leake
2014-12-07 23:28 ` Stefan Monnier
2014-12-08 9:34 ` Stephen Leake
2014-12-08 10:22 ` Thien-Thi Nguyen
2014-12-08 14:58 ` Stefan Monnier
2014-12-08 23:32 ` Stephen Leake
2014-12-09 11:00 ` Richard Stallman
2014-12-09 11:09 ` David Kastrup
2014-12-10 8:24 ` Richard Stallman
2014-12-10 17:05 ` Stephen Leake
2014-12-10 19:08 ` Stefan Monnier
2014-12-08 15:54 ` Eli Zaretskii
2014-12-08 23:33 ` Stephen Leake
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=85k324h0hg.fsf@stephe-leake.org \
--to=stephen_leake@stephe-leake.org \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.