[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Ambiguity in commit message conventions for org
From: |
Robert Pluim |
Subject: |
Ambiguity in commit message conventions for org |
Date: |
Fri, 10 Jun 2022 16:37:08 +0200 |
>>>>> 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
message.
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.
Thanks
Robert
--
- Re: Timestamp with repeater interval AND END DATE?, Robert Pluim, 2022/06/10
- Re: Timestamp with repeater interval AND END DATE?, Angel de Vicente, 2022/06/10
- Re: Timestamp with repeater interval AND END DATE?, Robert Pluim, 2022/06/10
- Re: Timestamp with repeater interval AND END DATE?, Ihor Radchenko, 2022/06/10
- Re: Timestamp with repeater interval AND END DATE?, Robert Pluim, 2022/06/10
- Re: Timestamp with repeater interval AND END DATE?, Ihor Radchenko, 2022/06/10
- Re: Timestamp with repeater interval AND END DATE?, Robert Pluim, 2022/06/10
- Re: Timestamp with repeater interval AND END DATE?, Ihor Radchenko, 2022/06/11
- Ambiguity in commit message conventions for org,
Robert Pluim <=
- Re: Ambiguity in commit message conventions for org, Ihor Radchenko, 2022/06/10
- Re: Ambiguity in commit message conventions for org, Robert Pluim, 2022/06/10