Re: [PATCH] CONTRIBUTE: Link WORG page when explaining commit message format
On 23 Apr 2022, Ihor Radchenko wrote: Applied. The patch is now on main as 67efaa739. Thanks, Ihor! Best regards, -Karl
Re: [PATCH] CONTRIBUTE: Link WORG page when explaining commit message format
Applied. The patch is now on main as 67efaa739. Best, Ihor
Re: [PATCH] CONTRIBUTE: Link WORG page when explaining commit message format
Robert Pluim writes: > It might be good to mention `magit-generate-changelog' there as an > easy way to produce the ChangeLog format entry (it doesnʼt require you > to iterate over the diff hunks, and you can call it from the magit > commit buffer). Note that we already mention `magit-commit-add-log` in https://orgmode.org/worg/org-contribute.html#commit-messages I personally dislike magit-generate-changelog because it tempts to document only a single change in a function, even when multiple changes were made in that function. However, the command might indeed be useful for others. It could be a good addition to https://orgmode.org/worg/org-contribute.org I do not think that magit staff belongs to CONTRIBUTE file directly. Patches are welcome. Best, Ihor
Re: [PATCH] CONTRIBUTE: Link WORG page when explaining commit message format
On 15 Apr 2022, Robert Pluim wrote: On Fri, 15 Apr 2022 17:33:33 +0800, Ihor Radchenko said: Ihor> - Org mode no longer uses ChangeLog entries to document changes. Ihor> - Instead, special commit messages are used, as described in the Ihor> - `CONTRIBUTE' file in the main Emacs repository. Ihor> + Instead, special commit messages are used. The commit message Ihor> + format generally follows Emacs conventions, as described in the Ihor> + `CONTRIBUTE' file in the main Emacs repository. Several more Ihor> + Org-specific conventions are described in Ihor> + [[https://orgmode.org/worg/org-contribute.html#commit-messages][worg/org-contribute#commit-messages]]. It might be good to mention `magit-generate-changelog' there as an easy way to produce the ChangeLog format entry (it doesnʼt require you to iterate over the diff hunks, and you can call it from the magit commit buffer). I really like the patch, Ihor -- it's already a big improvement! (I haven't tested Robert's suggestion of `magit-generate-changelog', but it seems like a reasonable hint to include, given Magit's popularity.) Best regards, -Karl
Re: [PATCH] CONTRIBUTE: Link WORG page when explaining commit message format
> On Fri, 15 Apr 2022 17:33:33 +0800, Ihor Radchenko > said: Ihor> - Org mode no longer uses ChangeLog entries to document changes. Ihor> - Instead, special commit messages are used, as described in the Ihor> - `CONTRIBUTE' file in the main Emacs repository. Ihor> + Instead, special commit messages are used. The commit message Ihor> + format generally follows Emacs conventions, as described in the Ihor> + `CONTRIBUTE' file in the main Emacs repository. Several more Ihor> + Org-specific conventions are described in Ihor> + [[https://orgmode.org/worg/org-contribute.html#commit-messages][worg/org-contribute#commit-messages]]. It might be good to mention `magit-generate-changelog' there as an easy way to produce the ChangeLog format entry (it doesnʼt require you to iterate over the diff hunks, and you can call it from the magit commit buffer). Robert --
[PATCH] CONTRIBUTE: Link WORG page when explaining commit message format
Karl Fogel writes: > So, naturally, after I read that item, I assumed that I was ready > to write the commit message, since I already knew Emacs's > guidelines. Thanks for the detailed explanation! Attaching tentative patch with clarification. Best, Ihor >From cd5e965d079aa7a3ac842e8ea3ea5762e2d80985 Mon Sep 17 00:00:00 2001 Message-Id: From: Ihor Radchenko Date: Fri, 15 Apr 2022 17:29:47 +0800 Subject: [PATCH] CONTRIBUTE: Link WORG page when explaining commit message format * CONTRIBUTE (Main contribution rules): Link relevant WORG contribute page section with extra conventions for our commit message guidelines. See https://orgmode.org/list/87r16896gh@red-bean.com --- CONTRIBUTE | 7 +-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTE b/CONTRIBUTE index 94d471a0f..f8a81515e 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE @@ -55,8 +55,11 @@ Org maintenance is detailed on Worg: see [[https://orgmode.org/worg/org-maintena the [[https://www.gnu.org/philosophy/kind-communication.en.html][GNU Kind Communications Guidelines]]. - Org mode no longer uses ChangeLog entries to document changes. - Instead, special commit messages are used, as described in the - `CONTRIBUTE' file in the main Emacs repository. + Instead, special commit messages are used. The commit message + format generally follows Emacs conventions, as described in the + `CONTRIBUTE' file in the main Emacs repository. Several more + Org-specific conventions are described in + [[https://orgmode.org/worg/org-contribute.html#commit-messages][worg/org-contribute#commit-messages]]. - Among other things, Org mode is widely appreciated because of its simplicity, cleanness and consistency. We should try to preserve -- 2.35.1
