[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [WORG] Document in more detail about what maintainers do?
From: |
Ihor Radchenko |
Subject: |
Re: [WORG] Document in more detail about what maintainers do? |
Date: |
Thu, 29 Sep 2022 15:06:57 +0800 |
Bastien <bzg@gnu.org> writes:
> Ihor Radchenko <yantar92@gmail.com> writes:
>
>> I think the part about CC is missing in
>> https://orgmode.org/worg/org-maintenance.html#orga0c76fb
>
> Indeed - can you add it?
>> Also, I find it important to take note about worg documentation for
>> built-in babel backends. I did not even know it exist for a long time.
>>
>> WDYT?
>
> +1 -- and also suggest adding tests, a part that I missed.
See the attached.
> Also, I'd more comfortable if org-maintenance.org would use stable
> anchors (not #orga0c76fb).
Done.
https://git.sr.ht/~bzg/worg/commit/b8c2bac21995747fa0c2f98d7b8e9dd7eaa30741
>From 23d5ffc8d1bb065cb98dc7f7eb1464575e41c9ad Mon Sep 17 00:00:00 2001
Message-Id:
<23d5ffc8d1bb065cb98dc7f7eb1464575e41c9ad.1664435121.git.yantar92@gmail.com>
From: Ihor Radchenko <yantar92@gmail.com>
Date: Thu, 29 Sep 2022 15:03:48 +0800
Subject: [PATCH] org-maintenance.org: Add details about the maintainer duties
* org-maintenance.org (What is the role of a maintainer?): Add details
about CCing from the list, maintaining tests, and updating babel
docs. Rewrite referring to the reader personally in all the places.
---
org-maintenance.org | 36 ++++++++++++++++++++++++------------
1 file changed, 24 insertions(+), 12 deletions(-)
diff --git a/org-maintenance.org b/org-maintenance.org
index 812cfbce..f5cc70eb 100644
--- a/org-maintenance.org
+++ b/org-maintenance.org
@@ -70,21 +70,33 @@ * What is the role of a maintainer?
:END:
If you speak [[https://learnxinyminutes.com/docs/elisp/][Emacs lisp]] and are
a regular user of an Org file, please
-consider becoming a maintainer for it: you can simply ask on the list.
+consider becoming a maintainer for it: you can simply ask on the
[[https://orgmode.org/worg/org-mailing-list.html][list]].
-The maintainer does not need to be an expert of the functionality in
-the file or to actively improve the file. He or she takes care of bug
-reports and feature requests against this file by participating to the
-discussion on the list.
+You do not need to be an expert of the functionality in the file or to
+actively improve the file. Just take care of bug reports and feature
+requests against this file by participating to the discussion on the
+[[https://orgmode.org/worg/org-mailing-list.html][list]].
-Org maintainers need to join [[https://savannah.gnu.org/git/?group=emacs][the
Emacs group on Savannah]]. When this
-is done, they have access to the
[[https://git.savannah.gnu.org/cgit/emacs/org-mode.git/][org-mode.git]]
repository and can push
-changes without asking for permission first. If the change is a new
-feature, they should discuss it on the list first.
+You are not strictly required to follow the mailing list closely and
+watch for the relevant emails. When necessary, the relevant messages
+will be directly forwarded to your email.
-In case the change touches files maintained by other maintainers, they
-need to review and validate it first. If Org's maintainer disagrees
-with a change, he can ask a maintainer to revert it.
+As a maintainer, you will need to join
[[https://savannah.gnu.org/git/?group=emacs][the Emacs group on Savannah]].
+When this is done, you will have access to the
[[https://git.savannah.gnu.org/cgit/emacs/org-mode.git/][org-mode.git]]
repository
+and will be able to push changes without asking for permission first.
+If your change is a new feature, discuss it on the
[[https://orgmode.org/worg/org-mailing-list.html][list]] first.
+
+In case the change touches files maintained by other maintainers, ask
+them to review and validate it first. If Org's maintainer disagrees
+with a change, he can ask you to revert it.
+
+When possible, please accompany bug fixes and new features with tests.
+The Org test infrastructure is detailed in
[[https://git.savannah.gnu.org/cgit/emacs/org-mode.git/tree/testing/README][testing/README]]
file in the
+Org repository.
+
+If you are the maintainer of one of the babel language backends,
+please make sure that the
[[https://orgmode.org/worg/org-contrib/babel/languages/index.html][language
documentation in WORG]] is
+up-to-date.
See also this steps for
[[https://orgmode.org/worg/org-contribute.html#devs][your first commit as a]]
maintainer.
--
2.35.1
--
Ihor Radchenko,
Org mode contributor,
Learn more about Org mode at https://orgmode.org/.
Support Org development at https://liberapay.com/org-mode,
or support my work at https://liberapay.com/yantar92