emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Robert Pluim <rpluim@gmail.com>
To: Ihor Radchenko <yantar92@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Ambiguity in commit message conventions for org
Date: Fri, 10 Jun 2022 18:02:09 +0200	[thread overview]
Message-ID: <87edzw1p8e.fsf@gmail.com> (raw)
In-Reply-To: <87a6akr1te.fsf@localhost> (Ihor Radchenko's message of "Fri, 10 Jun 2022 23:11:09 +0800")

>>>>> On Fri, 10 Jun 2022 23:11:09 +0800, Ihor Radchenko <yantar92@gmail.com> said:

    Ihor> Robert Pluim <rpluim@gmail.com> writes:
    Ihor> See https://orgmode.org/worg/org-contribute.html
    >> Those conventions are slightly different than Emacs', with one point
    >> of ambiguity. They say
    >> ...
    >> The summary line contains the 'lisp' directory, but the ChangeLog entry
    >> doesnʼt, and in the example just after itʼs the other way around:

    Ihor> You are right. The example is indeed a bit confusing. The main
    Ihor> difference between Emacs' and Org's converntions is in summary line. We
    Ihor> are less formal about and prefer shorter summaries. You can drop the
    Ihor> directory or even file name if it saves space and does not create
    Ihor> amiguity.

Emacs convention is to not mention the file name in the summary,
unless itʼs a one-file change, in which case you put the filename with
'* ' prepended (although some contributors prefer not to do that).

I went for 'dir/filename' in the summary, since Iʼm lazy and can copy
that from the ChangeLog commit message :-)


      reply	other threads:[~2022-06-10 16:13 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-31 13:46 Timestamp with repeater interval AND END DATE? Angel de Vicente
2022-05-31 14:03 ` Eric S Fraga
2022-05-31 14:36   ` Angel de Vicente
2022-06-10  8:44     ` Robert Pluim
2022-06-10 11:27       ` Angel de Vicente
2022-06-10 12:45         ` Robert Pluim
2022-06-10 12:59           ` Ihor Radchenko
2022-06-10 14:24             ` Robert Pluim
2022-06-10 15:03               ` Ihor Radchenko
2022-06-10 15:59                 ` Robert Pluim
2022-06-11  4:51                   ` Ihor Radchenko
2022-06-10 14:37             ` Ambiguity in commit message conventions for org Robert Pluim
2022-06-10 15:11               ` Ihor Radchenko
2022-06-10 16:02                 ` Robert Pluim [this message]

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:

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87edzw1p8e.fsf@gmail.com \
    --to=rpluim@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=yantar92@gmail.com \


* 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 public inbox


This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).