emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Bastien <bzg@gnu.org>
To: Mario Frasca <mario@anche.no>
Cc: emacs-orgmode@gnu.org
Subject: Re: `with` as a list.
Date: Wed, 03 Jun 2020 17:29:47 +0200	[thread overview]
Message-ID: <87o8q0rwus.fsf@gnu.org> (raw)
In-Reply-To: <15c8b193-6bf5-5248-c557-d28c0c25f123@anche.no> (Mario Frasca's message of "Wed, 3 Jun 2020 10:18:13 -0500")

Mario Frasca <mario@anche.no> writes:

> I'm sure you do understand what I mean, and I guess you know what
> would be the correctly formatted version.  can you show me?  

Yes.  You mentioned earlier that you missed this section:

Let me quote the text from this section:

A commit message should be constructed in the following way:

    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.

    Line 2 is an empty line.

    In line 3, the ChangeLog entry should start. A ChangeLog entry
    looks like this:

      * org-timer.el (org-timer-cancel-timer, org-timer-stop): Enhance
      (org-timer-set-timer): Use the number of minutes in the Effort
      property as the default timer value. Three prefix arguments will
      ignore the Effort value property.

The few lines above is what we called the "changelog".  It should be
the first part of the commit message -- after which you can add more
free-form context and explanations, if needed.

When you are on a function/variable that you updated in the modified
version of your code, you can create a changelog entry by hitting the
`C-x 4 a' keybinding.

This will open a new buffer, quote the function or variable, and let
you write a short sentence (starting with an uppercase letter and
ending with the ".", as a regular sentence.)

See these examples:


> next time I'll do better, but as of now, I obviously do not
> understand what you want, and why. 

I hope it is a bit more clear now.

> I was busy amending my other patches, and preparing a few more, but
> let's save time on both sides, and I'll give up for the time being.

You did the hardest part, which is to fix things, I hope you will be 
able to update the formatting of the commit messages.

As for the "why", this is because Org follows the same conventions
than Emacs when it comes to commit messages (partly because Org is
part of Emacs.)

Thanks in advance for when you'll feel motivated again!


  reply	other threads:[~2020-06-03 15:30 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-22 16:07 `with` as a list Mario Frasca
2020-05-28 13:34 ` [PATCH] [FEATURE] " Mario Frasca
2020-05-30  6:22 ` Kyle Meyer
2020-05-30 14:23   ` Mario Frasca
2020-05-30 14:38     ` Mario Frasca
2020-05-30 20:23     ` Kyle Meyer
2020-05-30 21:29       ` Mario Frasca
2020-05-31 20:18         ` Mario Frasca
2020-06-01  0:19           ` Kyle Meyer
2020-06-01  1:47             ` Mario Frasca
2020-06-01  2:31               ` Kyle Meyer
2020-06-03 15:09                 ` Mario Frasca
2020-06-03 15:13                   ` Bastien
2020-06-03 15:18                     ` Mario Frasca
2020-06-03 15:29                       ` Bastien [this message]
2020-06-03 17:08                         ` Mario Frasca
2020-06-03 22:15                         ` Mario Frasca
2020-06-03 15:25                     ` Mario Frasca
2020-06-03 15:30                       ` Bastien
2020-05-30 16:01   ` Mario Frasca
2020-05-30 20:25     ` Kyle Meyer
2020-05-30 21:36       ` Mario Frasca
2020-05-31  0:36         ` Kyle Meyer

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=87o8q0rwus.fsf@gnu.org \
    --to=bzg@gnu.org \
    --cc=emacs-orgmode@gnu.org \
    --cc=mario@anche.no \


* 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).