all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Karl Fogel <kfogel@red-bean.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: Alan Mackenzie <acm@muc.de>, emacs-devel@gnu.org
Subject: Re: Summarizing the purpose of a change.
Date: Sun, 22 Nov 2009 11:02:25 -0600	[thread overview]
Message-ID: <87r5rqbihq.fsf@red-bean.com> (raw)
In-Reply-To: <834ooooxp6.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 21 Nov 2009 14:43:17 +0200")

Eli Zaretskii <eliz@gnu.org> writes:
>> > In many projects, there is a convention of summarizing the purpose of a
>> > change in one or two sentences at the start of the log entry.  This
>> > makes the rest of the log entry (and the change itself) easier to
>> > understand.
>> 
>> > Could we try that in Emacs?  Or is there some reason we don't do it?
>> 
>> I do this every time.  So far, nobody's complained.
>
> I do this when I commit large sets of changes.  It could be a nuisance
> to do that for simple changes in a single file, though.

Yup.  I'm talking about just the situation where a summary is necessary.
For an easy fix in a single file, the technical description of the
change can also be the summary -- no one needs more.  Only when the
change is not its own summary is a summary is needed.

So far, everyone who's chimed in has basically said "Yeah, I try to do
this".  But my question is more about making it policy, in the sense
that of making it appropriate to follow up to change saying "How about a
summary line for that?"

-K




  reply	other threads:[~2009-11-22 17:02 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <E1NBhoZ-0007oj-Uv@cvs.savannah.gnu.org>
2009-11-21  7:09 ` Summarizing the purpose of a change Karl Fogel
2009-11-21  8:07   ` Miles Bader
2009-11-21  9:11     ` Eli Zaretskii
2009-11-21 11:29       ` Giorgos Keramidas
2009-11-21 12:19   ` Alan Mackenzie
2009-11-21 12:43     ` Eli Zaretskii
2009-11-22 17:02       ` Karl Fogel [this message]
2009-11-23  1:53         ` Stefan Monnier
2009-11-23  2:20           ` Karl Fogel
2009-11-24 15:12             ` Thien-Thi Nguyen
2009-11-24 15:41               ` Alfred M. Szmidt
2009-11-25 21:02                 ` Richard Stallman
2009-11-26 20:20                   ` Thien-Thi Nguyen
2009-11-27  6:35                     ` Richard Stallman

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=87r5rqbihq.fsf@red-bean.com \
    --to=kfogel@red-bean.com \
    --cc=acm@muc.de \
    --cc=eliz@gnu.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.