emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Ambiguity in commit message conventions for org


From: Ihor Radchenko
Subject: Re: Ambiguity in commit message conventions for org
Date: Fri, 10 Jun 2022 23:11:09 +0800

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:

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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]