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: Ambiguity in commit message conventions for org
Date: Fri, 10 Jun 2022 16:37:08 +0200	[thread overview]
Message-ID: <87mtek1t63.fsf_-_@gmail.com> (raw)
In-Reply-To: <87r13wr7x1.fsf@localhost> (Ihor Radchenko's message of "Fri, 10 Jun 2022 20:59:22 +0800")

>>>>> On Fri, 10 Jun 2022 20:59:22 +0800, Ihor Radchenko <yantar92@gmail.com> said:

    Ihor> Just submit a patch here. Against the Org mode repository.
    Ihor> Org mode development happens in Org mode repository and in this mailing
    Ihor> list, not in Emacs repo.

    Ihor> See https://orgmode.org/worg/org-contribute.html

Those conventions are slightly different than Emacs', with one point
of ambiguity. They say

    * Line 1 of the commit message should always be a short description of
     the overall change. Line 1 does not get a dot at the end and does not
     start with a star. Generally, it starts with the filename that has been
     changed, followed by a colon, like this: 

    lisp/ol-man.el: Restore file
    * Line 2 is an empty line.
    * Line 3 starts the ChangeLog entry. It looks like this: 

    * org-timer.el (org-timer-cancel-timer, org-timer-stop): Enhance

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:

    Here is an example for such a message: 

    org-capture.el: Fix the case of using a template file

    * lisp/org-capture.el (org-capture-set-plist): Make sure txt is a
    string before calling `string-match'.
    (org-capture-templates): Fix customization type.

    * doc/org.texi (Capture): Document using a file for a template.



  parent reply	other threads:[~2022-06-10 14:38 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             ` Robert Pluim [this message]
2022-06-10 15:11               ` Ambiguity in commit message conventions for org Ihor Radchenko
2022-06-10 16:02                 ` Robert Pluim

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=87mtek1t63.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).