Ihor Radchenko <yanta...@posteo.net> writes: > Corwin recently noticed that our > https://orgmode.org/worg/worg-about.html page is not very consistent > about whom and how should contribute to WORG. > > One part of that page suggests to "Create an account on Sourcehut" and > then push changes freely, while another part suggests going through the > mailing list. > ...
While it is a good idea to allow web edits somehow, it is probably not going to happen soon. So, at least, let me try to address the original confusion. I tried to reword worg-about to give instructions for people familiar with git *and also people not familiar with git*. See the attached tentative patch.
>From 372cef8fa443ee7586051a046de2a6b4b7252531 Mon Sep 17 00:00:00 2001 Message-ID: <372cef8fa443ee7586051a046de2a6b4b7252531.1745740639.git.yanta...@posteo.net> From: Ihor Radchenko <yanta...@posteo.net> Date: Sun, 27 Apr 2025 09:55:05 +0200 Subject: [PATCH] worg-about.org: Suggest sending edits to the mailing list, not just git * worg-about.org (Who can participate in the editing of Worg?): Give a brief advice to people unfamiliar with Git. (OK, I want to *contribute to Worg* now!): Make using Git optional. (The first time you contribute to Worg): Do not force contributors to request write access all the time. Highlight that it is optional. (The second time you contribute to Worg): Explain what to do without write access. Link: https://orgmode.org/list/875xmbdxyu.fsf@localhost --- worg-about.org | 45 ++++++++++++++++++++++++++++++++------------- 1 file changed, 32 insertions(+), 13 deletions(-) diff --git a/worg-about.org b/worg-about.org index db489ace..666ddd2a 100644 --- a/worg-about.org +++ b/worg-about.org @@ -23,14 +23,17 @@ * What is Worg? What is its relation to Org? * Who can participate in the editing of Worg? -Everyone with a minimal knowledge of Org (and Emacs) and git. +Everyone with a minimal knowledge of Org (and Emacs). -You need to register on [[https://sr.ht][Sourcehut]] and ask to be added to the [[https://git.sr.ht/~bzg/worg][Worg -project]]. +You can download =.org= source for any WORG page by replacing =.html= +with =.org= in the URL. Then, [[mailto:emacs-orgmode@gnu.org][send an email]] to Org mailing list with +your suggestions or edits. -If you are lost, you can ask [[mailto:cont...@tecosaur.net][Timothy]] for help. +If you are familiar with Git, you can directly make edits to Worg +sources. See the section describing [[#git][how to use git for Worg]] for +details. -See the section describing [[#git][How to use git for Worg]] for details. +If you are lost, you can ask [[mailto:cont...@tecosaur.net][Timothy]] for help. * Who's in charge of Worg? @@ -58,16 +61,16 @@ * Why use Org-mode for creating a collaborative website? * OK, I want to *contribute to Worg* now! -First, review [[#git][How to use git for Worg]]. - -Then, you may be interested in general advice and conventions on how +First, you may be interested in general advice and conventions on how to [[file:worg-editing.org][let Worg grow]]. If you're interested in how Worg publishes itself as a website, see the [[file:worg-setup.org][Worg setup]] page. Once you are familiar with the above, you can contribute by sending -patches against the Worg repository to the [[file:org-mailing-list.org][Org mailing list]]. +your edits to the [[file:org-mailing-list.org][Org mailing list]]. + +If you want to contribute via Git, review [[#git][How to use git for Worg]]. : ~$ git clone https://git.sr.ht/~bzg/worg @@ -88,15 +91,21 @@ *** The first time you contribute to Worg :CUSTOM_ID: contribute-to-worg :END: -1. Create an account on [[https://sr.ht][Sourcehut]]. Make sure that your [[https://git-scm.com/book/en/v2/Git-on-the-Server-Generating-Your-SSH-Public-Key][public SSH key]] - has been added to your profile. +1. (optional) Create an account on [[https://sr.ht][Sourcehut]]. Make sure that your + [[https://git-scm.com/book/en/v2/Git-on-the-Server-Generating-Your-SSH-Public-Key][public SSH key]] has been added to your profile. -2. Request write access to [[https://git.sr.ht/~bzg/worg][the Worg repo]]. +2. (optional) Request write access to [[https://git.sr.ht/~bzg/worg][the Worg repo]]. 3. Clone the project somewhere in a working directory: + If you have write access, + : ~$ git clone g...@git.sr.ht:~bzg/worg + Otherwise, + + : ~$ git clone https://git.sr.ht/~bzg/worg + 4. Go to the newly created =worg/= directory and edit some files. 5. If you created files, add them to the git index: @@ -107,10 +116,16 @@ *** The first time you contribute to Worg : ~$ git commit -a -m "summary comment about all changes" -7. When you are a collaborator, push your change to Worg: +7. If you are have write access, push your change directly to Worg: : ~$ git push +8. If you do not have write access, create a patch and send it to [[mailto:emacs-orgmode@gnu.org][the mailing list]] + + : ~$ git format-patch origin/master + + This will create a patch file that you can attach to your email + The system is designed for immediate updates -- if not, it means something is wrong. You should be able to read the error message and see what is wrong, then help with fixing issues. In general the @@ -135,6 +150,10 @@ *** The second time you contribute to Worg : ~$ git push + or create a patch and send it to [[mailto:emacs-orgmode@gnu.org][the mailing list]] + + : ~$ git format-patch origin/master + *** Going deeper **** Getting organized -- 2.49.0
-- Ihor Radchenko // yantar92, Org mode maintainer, 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>
