Karl Fogel <kfo...@red-bean.com> 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: <cd5e965d079aa7a3ac842e8ea3ea5762e2d80985.1650015125.git.yanta...@gmail.com>
From: Ihor Radchenko <yanta...@gmail.com>
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

Reply via email to