Re: Ambiguity in commit message conventions for org
> On Fri, 10 Jun 2022 23:11:09 +0800, Ihor Radchenko > said: Ihor> Robert Pluim 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 :-) Robert --
Re: Ambiguity in commit message conventions for org
Robert Pluim 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: You are right. The example is indeed a bit confusing. The main difference between Emacs' and Org's converntions is in summary line. We are less formal about and prefer shorter summaries. You can drop the directory or even file name if it saves space and does not create amiguity. The most common types for summary lines are: org-library.el: Changed this library-name: Changed that function-name: Fixed variable-name: ... Examples: org-lint: Fix invocation with C-u prefix argument org-cycle-hide-block-startup: Fix docstring manual: Fix function name and key index reference You can also refer to https://git.savannah.gnu.org/cgit/emacs/org-mode.git/log/ Best, Ihor
Ambiguity in commit message conventions for org
> On Fri, 10 Jun 2022 20:59:22 +0800, Ihor Radchenko > 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 --
