From: Tim Visher <tim.visher@gmail.com>
To: Ihor Radchenko <yantar92@posteo.net>
Cc: Emacs Org Mode mailing list <emacs-orgmode@gnu.org>
Subject: Re: [PATCH] org-capture.el: Allow `(here)' as a template target
Date: Thu, 22 Jun 2023 09:53:15 -0400 [thread overview]
Message-ID: <CAHa53uwGT64MBorz0sTVvpJAfDjiVZ_Z4oiMskvSFFmYmoAY-Q@mail.gmail.com> (raw)
In-Reply-To: <87fs6jdcl3.fsf@localhost>
[-- Attachment #1.1: Type: text/plain, Size: 1061 bytes --]
On Thu, Jun 22, 2023 at 6:13 AM Ihor Radchenko <yantar92@posteo.net> wrote:
> Tim Visher <tim.visher@gmail.com> writes:
>
> > Will do! I've attached a prospective patch file but I'm not sure I follow
> > what you mean by 'add all the necessary changelog entries to the final
> > commit
> > message'. Looking at this commit
> > <
> https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=294a4d2fe21ffcdc1acbbafed1bfc69a1ece7d13
> >
> > I'm guessing that I should have an `* …` entry for every file except
> > `etc/NEWS` that I changed so I've done that but please do let me know if
> > that was the wrong interpretation. :)
>
> Applied, onto main, amending the changelog entries.
> https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=bea9fca18
>
> Should be an entry for every file, including ORG-NEWS, followed by more
> general comments.
>
🤜 🤛 !!! :)
I've attached a small follow up `worg` patch to hopefully clarify the
changelog section of the commit message going forward for other
contributors.
[-- Attachment #1.2: Type: text/html, Size: 1816 bytes --]
[-- Attachment #2: 0001-org-contribute.org-Clarify-files-to-include-in-chang.patch --]
[-- Type: application/octet-stream, Size: 1371 bytes --]
From 54726ecbf000c6d2bbf1667df5bda98362121f45 Mon Sep 17 00:00:00 2001
From: Tim Visher <tim.visher@gmail.com>
Date: Thu, 22 Jun 2023 09:47:52 -0400
Subject: [PATCH] org-contribute.org: Clarify files to include in changelog
section
* org-contribute.org (What's in a commit message?): Clarify that /all/
files should be included in the changelog section of the commit
message, including `org-manual.org' and `ORG-NEWS'.
TINYCHANGE
---
org-contribute.org | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/org-contribute.org b/org-contribute.org
index bab9e798..0f17df32 100644
--- a/org-contribute.org
+++ b/org-contribute.org
@@ -303,6 +303,12 @@ A commit message should be constructed in the following way:
: property as the default timer value. Three prefix arguments will
: ignore the Effort value property.
+ *Note:* There should be an entry for /every/ file changed in the
+ commit. This includes, for instance, =etc/ORG-NEWS= and
+ =doc/org-manual.org= if your change was relevant there. [[https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=bea9fca18][This]] is a
+ good example of a =TINYCHANGE= that also touched the manual and news
+ files.
+
- After the ChangeLog entry, another empty line should come before any
additional information that the committer wishes to provide in order
to explain the patch.
--
2.40.1
next prev parent reply other threads:[~2023-06-22 13:55 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-12 15:35 [PATCH] org-capture.el: Allow `(here)' as a template target Tim Visher
2023-05-12 16:35 ` Ihor Radchenko
2023-06-20 19:32 ` Tim Visher
2023-06-21 10:33 ` Ihor Radchenko
2023-06-21 13:12 ` Tim Visher
2023-06-21 15:59 ` Ihor Radchenko
2023-06-21 18:30 ` Tim Visher
2023-06-22 10:18 ` Ihor Radchenko
2023-06-22 13:53 ` Tim Visher [this message]
2023-06-23 10:58 ` Ihor Radchenko
2023-06-23 12:02 ` Tim Visher
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:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
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=CAHa53uwGT64MBorz0sTVvpJAfDjiVZ_Z4oiMskvSFFmYmoAY-Q@mail.gmail.com \
--to=tim.visher@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=yantar92@posteo.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* 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
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
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).