From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id gHGTL242YGH+HwEAgWs5BA (envelope-from ) for ; Fri, 08 Oct 2021 14:15:42 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id WBxsKW42YGFJVAAAbx9fmQ (envelope-from ) for ; Fri, 08 Oct 2021 12:15:42 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 9FC2021045 for ; Fri, 8 Oct 2021 14:15:41 +0200 (CEST) Received: from localhost ([::1]:41268 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mYomp-0007pz-KT for larch@yhetil.org; Fri, 08 Oct 2021 08:15:39 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:57550) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mYolv-0007mI-UW for emacs-orgmode@gnu.org; Fri, 08 Oct 2021 08:14:43 -0400 Received: from relay-egress-host.us-east-2.a.mail.umich.edu ([13.59.128.245]:60736 helo=canny-olwen.relay-egress.a.mail.umich.edu) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mYolq-0006gf-7X; Fri, 08 Oct 2021 08:14:43 -0400 Received: from prettiest-kishi.authn-relay.a.mail.umich.edu (ip-10-0-74-136.us-east-2.compute.internal [10.0.74.136]) by canny-olwen.relay-egress.a.mail.umich.edu with ESMTPS id 61603629.B8907.5BE0EBDA.1335148; Fri, 08 Oct 2021 08:14:33 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=umich.edu; s=relay-2018-08-29; t=1633695273; bh=ont/bdW99qmDyiEoB2VNieVDLPARlAX1UAynWyeYLIg=; h=To:cc:From:Subject:In-reply-to:References:Date; b=oGNlWhmDFaUGutj0zTA/nw9sO+hzIKudN678QchLzcb+z0VYKNyPNJJN1OrQzu3l/ DDyVxvJ96bUOJ7dMKhIp2p+c2CKg0+lG+d9Rv//RJk+p+WUI8YfyLTAvd427iHdD9J lsCSz9OxibOVaiBKkd/SVne9S8+mputgufrioAQJmD6+/V23jRGKQozEVoIM5GsDgj quiBd9JmPrUI4V0WHoHist24kbN8LrcjEgWLrDyHc9u7282dmqbwtoJiDvVEs+FiDg qyV/MRTRrRxVWs+C2+C2DbyjV2oyhgIVr63AU7gNOzUaODS7z0N4HtsLnDEd4yjw+K xTIOStNmLibjg== Received: from localhost (Mismatch [78.176.114.147]) by prettiest-kishi.authn-relay.a.mail.umich.edu with ESMTPSA id 61603628.C816.FAC01A.2907252; Fri, 08 Oct 2021 08:14:32 -0400 To: Bastien From: Greg Minshall Subject: Re: Someone to help merging orgmode.org/contribute.html and orgmode.org/worg/org-contribute.html ? In-reply-to: <87lf35c73e.fsf@gnu.org> References: <87zgrr7bbv.fsf@bzg.fr> <2487079.1633608934@apollo2.minshall.org> <87lf35c73e.fsf@gnu.org> Comments: In-reply-to Bastien message dated "Thu, 07 Oct 2021 15:11:49 +0200." X-Mailer: MH-E 8.6+git; nmh 1.7.1; GNU Emacs 27.2 MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Date: Fri, 08 Oct 2021 15:14:24 +0300 Message-ID: <2610038.1633695264@apollo2.minshall.org> Received-SPF: pass client-ip=13.59.128.245; envelope-from=minshall@umich.edu; helo=canny-olwen.relay-egress.a.mail.umich.edu X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_HTML_ATTACH=0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: emacs-orgmode@gnu.org Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1633695342; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=ont/bdW99qmDyiEoB2VNieVDLPARlAX1UAynWyeYLIg=; b=sugZkN1JkSHiV4xxkbpGIBTWMF6nqNWG1Vx16Gdw4lXD8lMAPo/OLPVofxsv7K468dQe24 vY31hxkLLYjm0InkwsmXDOL8UlPQpyNm/k6cUpdWc0mzIQnBE9pER/8/zajpJvuP2rtd/S cROhFQDAYuHtPrri4UHTrsh/OZfPPEk1GaTES8t85IfnS2/GwawtDA4iS0v6qWX5v5bEur DM4uXPiOB0ld2vLtUFMn5MIw6xYlI7vpEF48rMg1ETouQH7+wHrzML/WWzg2knERFw2ruK zlF/U4U85a9FtwB9vCyDbSB+OkpnZ24jAIDCWGBr9J0qqf6Pqu33HIL7GlwZGg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1633695342; a=rsa-sha256; cv=none; b=DQ1s0kqhyMWlySvIUlqYHWxnTJzLEKTQPWLiRKT+Vlv+knhSbPqioM0JNpch7pofkyq+yZ LaU8hhoyYyu5ebouiqzHXUR5tF5uTG8SMuRYYKvi1sXalfZ/8M/xmWyPQsZ2FcwyOhqv7E wNs2YFM3KSeW5mxvmVM4+6+GbIkNr72k2WE8V5mI9T1WtU9bHD5Qcr4GHsBA1aDv0vBHcP 0j5ksj074cBnxXKUeRH/L2q6Gf60o2uAPPu/1cKV8kfUHrM+HFMB5Ww0MLN72h9XQayIRm D78P0e1s4eli6DMialhs1wXut62HspaXpC82H3ODvFCo/9QsLgxu/u6CSc+mTw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=umich.edu header.s=relay-2018-08-29 header.b=oGNlWhmD; dmarc=pass (policy=none) header.from=umich.edu; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Spam-Score: 3.39 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=umich.edu header.s=relay-2018-08-29 header.b=oGNlWhmD; dmarc=pass (policy=none) header.from=umich.edu; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Queue-Id: 9FC2021045 X-Spam-Score: 3.39 X-Migadu-Scanner: scn0.migadu.com X-TUID: qHMWVIG986yw --=-=-= Content-Type: text/plain Bastien, > thanks a lot for volunteering, but I did the merge a few days ago. great! > Perhaps you can still carefully proofread > https://orgmode.org/worg/org-contribute.html and enhance it? sure. some comments and a patch (and, without the nice css, the .html file it generates, just for ease of reviewing). i was thinking of (more or less) sorting the "ways to contribute" in terms of difficulty/level of expertise required. the below patch tries to do this (ysomv -- your sort order may vary). other than that, i did a bit of editing, added a few links and footnotes, etc. nit: i don't know how widespread this is, or whether it matters when someone is looking on worg about how to contribute, but my setup (arch linux, qutebrowser) doesn't include : "C-x 8 RET 1f984" or "C-x 8 RET UNICORN FACE" hope it's of use. cheers, Greg --=-=-= Content-Type: text/x-diff; charset=utf-8 Content-Disposition: attachment; filename=0002-org-contribute.org-Edit-and-re-organize-slightly.patch Content-Transfer-Encoding: quoted-printable >From 8cf98908c94c2f8bbc0abcfc5cf948dc0a0820e3 Mon Sep 17 00:00:00 2001 From: Greg Minshall Date: Fri, 8 Oct 2021 15:08:17 +0300 Subject: [PATCH 2/2] org-contribute.org: Edit and re-organize slightly --- org-contribute.org | 90 ++++++++++++++++++++++++---------------------- 1 file changed, 48 insertions(+), 42 deletions(-) diff --git a/org-contribute.org b/org-contribute.org index a21c5223..d684ccdb 100644 --- a/org-contribute.org +++ b/org-contribute.org @@ -19,48 +19,54 @@ =20 The Org codebase is large, and contributing can be daunting at first, but don't hesitate to call for directions on [[file:org-mailing-list.org][= the mailing list]]. If you -are willing to help, there is plenty of low-hanging fruits for you and +are willing to help, there is plenty of low-hanging fruit for you, and the community will welcome your contribution. =20 -: When contributing, always beware of the maintenance burden: -: are you alleviating it or are you adding to it? +: When contributing, always keep the maintenance burden in mind: +: are you alleviating it, or are you adding to it? =20 * Ways to contribute =F0=9F=A6=84 :PROPERTIES: :CUSTOM_ID: types-of-contributions :END: =20 -- *Maintain an Org file*: If a file in the git repository does not have - a maintainer, and you want to help by maintaining it, please read - more on [[file:org-maintenance.org][how Org is maintained]] and let us k= now by sending an email to - [[file:org-mailing-list.org][the mailing list]]. +** Ways that do not involve programming =20 -- *Check the [[https://updates.orgmode.org/#help][requests for help]]*: If= you want to help with one of these - tasks, say so on the list. - -- *Check the [[https://updates.orgmode.org/#bugs][list of confirmed bugs]]= *: Even if you just provide more - information or ideas on how to fix them, this helps. +- *Send bug reports*. Before sending a bug report, make sure you read + the section of the manual on how to provide useful [[https://orgmode.org= /org.html#Feedback][feedback]] or this + other great text: [[http://www.chiark.greenend.org.uk/~sgtatham/bugs.htm= l][How to Send Bug Reports Effectively]]. =20 - *Try to reproduce bugs*: That's always very helpful. Do subscribe to [[https://lists.gnu.org/mailman/listinfo/emacs-orgmode][Org's mailing li= st]] and monitor new unreferenced bugs. Try to reproduce them. If you can reproduce a bug, reply to the original - poster and add =3DX-Woof-Bug: confirmed=3D to your mail headers, and the + poster and add [[https://github.com/bzg/woof][=3DX-Woof-Bug: confirmed= =3D]] to your mail headers, and the bug will then be shown on [[https://updates.orgmode.org/#bugs][updates.o= rgmode.org]]. =20 - *Help other users by replying to their questions* [[file:org-mailing-lis= t.org][on the mailing list]] or on [[file:org-web-social.org][other web places]]. =20 -- *Send bug reports*. Before sending a bug report, make sure you read - the section of the manual on how to provide useful [[https://orgmode.org= /org.html#Feedback][feedback]] or this - other great text: [[http://www.chiark.greenend.org.uk/~sgtatham/bugs.htm= l][How to Send Bug Reports Effectively]]. - -- *Submit patches* to the mailing list. See how to format [[#first-patch]= [your first - patch]] and [[#patches][details on how to submit it]]. - - *Contribute to Worg*. Worg is collaborative documentation made of Org files. It's very easy to contribute to it. Learn more [[file:worg-abou= t.org][about Worg]] and [[file:worg-about.org::*How to use git for Worg][how to contribute]]. =20 +- *Share ideas and feature requests*. Org is already mature, but new + ideas keep popping up. If you want to request a feature, first dig + into [[file:org-mailing-list.org][the mailing list]] to find similar pro= posals. If you cannot find + any, subscribe to the list, read it for a while, then make your + proposal. Formulate it with as much detail as possible, especially + with examples. + +** Ways that involve programming + +- *Check the [[https://updates.orgmode.org/#help][requests for help]]*: If= you want to help with one of these + tasks, say so on the list. + +- *Check the [[https://updates.orgmode.org/#bugs][list of confirmed bugs]]= *: Even if you just provide more + information or ideas on how to fix them, this helps. + +- *Submit patches* to the mailing list. See how to format [[#first-patch]= [your first + patch]] and [[#patches][details on how to submit it]]. + - *Write add-ons*. The best way is to submit your code to [[file:org-mail= ing-list.org][the mailing list]] and discuss it with people. Many add-ons are published through [[https://elpa.gnu.org/][GNU ELPA]] (for authors who signed the FSF copy= right assignment) and @@ -68,17 +74,16 @@ the community will welcome your contribution. assignment FSF if you want to add your code in Org's core, because it will end up in GNU Emacs. =20 -- *Share ideas and feature requests*. Org is already mature, but new - ideas keep popping up. If you want to request a feature, first dig - into [[file:org-mailing-list.org][the mailing list]] to find similar pro= posals. If you cannot find - any, subscribe to the list, read it for a while, then make your - proposal. Formulate it with as much detail as possible, especially - with examples. +- *Maintain an Org file*: If a file in the git repository does not + have a maintainer [fn:: =3Dgrep -lv "^;; Maintainer:" `find ./lisp + -name "*.el"` | less=3D] and you want to help by maintaining it, + please read more on [[file:org-maintenance.org][how Org is maintained]] = and let us know by sending + an email to [[file:org-mailing-list.org][the mailing list]]. =20 * What does NOT help =20 - Submitting feature requests without proper justification. -- Submitting "It does not work" bug reports. +- Submitting [[https://www.chiark.greenend.org.uk/~sgtatham/bugs.html]["It= does not work"]] bug reports. - Submitting ill-formatted patches. - Sending too many emails. - Arguing. @@ -97,8 +102,8 @@ Contributions are discussed on the [[https://orgmode.org= /worg/org-mailing-list.h reproducing the bug. Please make it easier by providing a minimal reproducible recipe. Check the manual on how to provide [[https://orgmo= de.org/manual/Feedback.html][feedback]]. If no one replies, don't take it personally: it either means that - nobody was able to reproduce the bug or that the bug is not that - critical for someone else to confirm it. + nobody was able to reproduce the bug or that the bug does not seem + that critical for someone else to confirm it. =20 - When you contribute with a patch :: Your patch will be listed on [[https://updates.orgmode.org][updates.orgmode.org]]. If this is your f= irst patch, don't expect the @@ -119,8 +124,9 @@ In general, if you want to raise awareness on an email = you sent, please wait at least for *one month* before bumping a thread. See [[file:= org-mailing-list.org::#i-didnt-receive-an-answer][What to do if you don't receive an answer]]. =20 -The Org mailing list has *contributor stewards* who will try their best -to make sure your contributions get all the attention they deserve. +The Org mailing list has volunteer *contributor stewards* who will try +their best to make sure your contributions get all the attention they +deserve. =20 * Your first patch as an occasional contributor :PROPERTIES: @@ -139,13 +145,11 @@ go through before submitting a patch: 6. If relevant, don't forget to update =3Ddoc/org-manual.org=3D 7. Take extra care of the commit message (see [[#commit-messages][Commit m= essages and ChangeLog entries]]) 8. If your change is small enough and you didn't sign the FSF - copyright assignment, include =3DTINYCHANGE=3D at the bottom of the - commit message. - -Your total contribution (all patches you submit) should change /less -than 15 lines/. See the [[http://git.savannah.gnu.org/cgit/emacs.git/tree/= CONTRIBUTE][CONTRIBUTE file in GNU Emacs]]. If you contribute -more, you have to assign the [[#copyright][copyright]] of your contributio= n to the -Free Software Foundation. + copyright assignment,[fn:: Your total contribution (all patches you + submit) should change /less than 15 lines/. See the [[http://git.savann= ah.gnu.org/cgit/emacs.git/tree/CONTRIBUTE][CONTRIBUTE file + in GNU Emacs]]. If you contribute more, you have to assign the + [[#copyright][copyright]] of your contribution to the Free Software Fou= ndation.] + include =3DTINYCHANGE=3D at the bottom of the commit message. =20 * Details on how to submit patches :PROPERTIES: @@ -160,7 +164,7 @@ Lisp coding conventions]] described in Emacs manual. ** Sending patches with Git =20 Please use Git to make patches and send them via email -- this is -perfectly fine for major and minor changes. +perfectly fine for both major and minor changes. =20 When sending a patch (using =3Dgit diff=3D, =3Dgit format-patch=3D or =3Dg= it send-email=3D, *always add a properly formatted Emacs ChangeLog entry* in @@ -193,13 +197,14 @@ To finally send the patches, you can either add them = as attachments to your email or use [[https://git-scm.com/docs/git-send-email][git send-emai= l]], if it's properly configured. =20 Write useful commit messages: please provide (1) a reason for it in -your email and (2) a ChangeLog entry in the commit message (see [[#commit-= messages][this -section]] on how to format a ChangeLog entry.) +your email and (2) a ChangeLog entry in the commit message (again, see +[[#commit-messages][this section]] on how to format a ChangeLog entry.) =20 ** Sending quick fixes for testing purpose =20 If you want to send a quick fix that needs to be further tested by -other people (before you submit a real patch), here is how you can do: +other people (before you submit a real patch), here is what you can +do: =20 #+begin_quote This command will make a patch between the staging area (in your @@ -268,6 +273,7 @@ A commit message should be constructed in the following= way: the overall change. Line 1 does /not/ get a dot at the end and does not start with a star. Generally, it starts with the filename that has been changed, followed by a colon, like this: + : lisp/ol-man.el: Restore file =20 - Line 2 is an empty line. =20 --=20 2.32.0 --=-=-= Content-Type: text/xml; charset=utf-8 Content-Disposition: attachment; filename=org-contribute.html Content-Transfer-Encoding: quoted-printable Contributing to Org

Contributing to Org

The Org codebase is large, and contributing can be daunting at first, but don't hesitate to call for directions on the mailing list. If you are willing to help, there is plenty of low-hanging fruit for you, and the community will welcome your contribution. 

When contributing, always keep the maintenance burden in mind:
are you alleviating it, or are you adding to it?

Ways to contribute =F0=9F=A6=84

Ways that do not involve programming

  • Send bug reports. Before sending a bug report, make sure you re= ad the section of the manual on how to provide useful feedback or this other great text: How to Send Bug Reports Effectively.
  • Try to reproduce bugs: That's always very helpful. Do subscribe= to Org's mail= ing list and monitor new unreferenced bugs. Try to reproduce them. If you can reproduce a bug, reply to the original poster and add X-Woof-Bug: co= nfirmed to your mail headers, and the bug will then be shown on upd= ates.orgmode.org.
  • Help other users by replying to their questions on the mailing list or on other web places.
  • Contribute to Worg. Worg is collaborative documentation made of= Org files. It's very easy to contribute to it. Learn more about Worg and how to contribute.
  • Share ideas and feature requests. Org is already mature, but new ideas keep popping up. If you want to request a feature, first dig into the mailing list to find similar= proposals. If you cannot find any, subscribe to the list, read it for a while, then make your proposal. Formulate it with as much detail as possible, especially with examples.

Ways that involve programming

What does NOT help

  • Submitting feature requests without proper justification.
  • Submitting "It does not work" bug reports.
  • Submitting ill-formatted patches.
  • Sending too many emails.
  • Arguing.

We follow the GNU Kind Communications Guidelines and ask you to follow them too.

As a contributor, what can I expect?

Contributions are discussed on the Org mailing list.

When you contribute with a bug report
Expect someone to try reproducing the bug. Please make it easier by providing a minimal reproducible recipe. Check the manual on how to provide feedback. If no one replies, don't take it personally: it either means that nobody was able to reproduce the bug or that the bug does not seem that critical for someone else to confirm it.
When you contribute with a patch
Your patch will be listed on updates.orgmode.org. If this i= s your first patch, don't expect the patch to be applied immediately. You can expect someone to review it and to suggest changes, either on the technical or formal aspects of the patch. If nobody seems to care enough to reply, don't take it personally: it means that maintainers are busy and/or that the patch does not seem critical enough.
When you contribute with an idea or a feature request
The best way to convince maintainers that your idea is worth considering is by detailing your use-case and by proposing a patch for it. Expect people to discuss the idea on the list, but please remember Org is very old now, used by many people with various needs. If nobody replies, don't take it personally.

In general, if you want to raise awareness on an email you sent, please wait at least for one month before bumping a thread. See What to do if you don't receive an answer.

The Org mailing list has volunteer contributor stewards who will try their best to make sure your contributions get all the attention they deserve.

Your first patch as an occasional contributor

You don't need write access to the repository to contribute with patches, just send them to the mailing li= st. Here is a checklist to go through before submitting a patch:

  1. Make your patch against the latest bugfix or main branch
  2. Run ~$ make test to catch broken tests
  3. Check compilation warnings with ~$ make compile
  4. If relevant, include or update tests
  5. If your patch is adding a feature, please update etc/ORG-NEWS
  6. If relevant, don't forget to update doc/org-manual.org
  7. Take extra care of the commit message (see Commit messages and ChangeLog entries)
  8. If your change is small enough and you didn't sign the FSF copyright assignment,2 include TINYCHANGE at the bottom of the commit message.

Details on how to submit patches

Coding conventions

Org is part of Emacs, so any contribution should follow the GNU Emacs Lisp coding conventions described in Emacs manual.

Sending patches with Git

Please use Git to make patches and send them via email – this is perfectly fine for both major and minor changes.

When sending a patch (using git diff, git format-patch or git send-email, always add a properly formatted Emacs ChangeLog entry= in the commit message. See this section for = details on how to create such a ChangeLog.

Sending commits

For every patch you send, we suggest to use git format-patch o= r git send-email. Here is a suggested workflow: 

~$ git pull                 # make sure your repo is up to date
~$ git branch my-changes    # create a new branch from main
~$ git checkout my-changes  # switch to this new branch

… make some changes (1) … 

~$ git commit -a -m "This is change (1)"  # Commit your change

… make another change (2) … 

~$ git commit -a -m "This is change (2)"  # Commit your change
~$ git format-patch main                 # Creates two patches

Then two patches for your two commits are ready to be sent to the list.

To finally send the patches, you can either add them as attachments to your email or use git s= end-email, if it's properly configured.

Write useful commit messages: please provide (1) a reason for it in your email and (2) a ChangeLog entry in the commit message (again, see this section on how to format a ChangeLog = entry.)

Sending quick fixes for testing purpose

If you want to send a quick fix that needs to be further tested by other people (before you submit a real patch), here is what you can do:

This command will make a patch between the staging area (in your computer), and the file you modified: 

git diff -p org-whatever.el > org-whatever.el.diff

If you already committed your changes to your index (staging area), then you should compare against a particular branch (in this example, origin/main): 

git diff -p origin/main org-whatever.el > org-whatever.el.diff

You email the output to the mailing list, adding [PATCH] to the subject, and description of what you fixed or changed.

Note that small patches sent like this still need to have a ChangeLog entry to be applied. If your patch looks good to you, it's always better to send a patch through git format-patch.

Sharing changes from a public branch

When discussing important changes, it is sometimes not so useful to send long and/or numerous patches.

In this case, you can maintain your changes on a public branch of a public clone of Org and send a link to the diff between your changes and the latest Org commit that sits in your clone.

If the discussion settles and your change is accepted, you can now send it as (a list of) patch(es) to the latest Org version.

Your first commit as an Org maintainer

Org regular contributors and maintainers have write access to the Git repository.

  1. Fill in this = form and wait for the FSF feedback
  2. Create an account on savannah.gnu.= org
  3. Request to join the Savannah Emacs group

Once you are granted access to the Emacs group:

  1. Apply your changes against the code and the documentation
  2. Run make test
  3. If the tests pass, commit and push your changes

If you are undertaking big changes, please create a dedicated branch locally and make sure you have a clean commit history before merging it into the bugfix or main branch.

To check our Git workflow, please read Org maintenance.

Commit messages and ChangeLog entries

A commit message should be constructed in the following way:

  • Line 1 of the commit message should always be a short description of the overall change. Line 1 does not get a dot at the end and does not start with a star. Generally, it starts with the filename that has been changed, followed by a colon, like this: 

    lisp/ol-man.el: Restore file
  • Line 2 is an empty line.

  • Line 3 starts the ChangeLog entry. It looks like this: 

    * org-timer.el (org-timer-cancel-timer, org-timer-stop): Enhance
message.
(org-timer-set-timer): Use the number of minutes in the Effort
property as the default timer value. Three prefix arguments will
ignore the Effort value property.
  • 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.
  • If the change is a minor change made by a committer without copyright assignment to the FSF, the commit message should also contain the cookie TINYCHANGE after the ChangeLog entry.
  • Variables and functions names are quoted like `this' (a ba= ckquote and a single quote).
  • Sentences should be separated by two spaces.
  • Sentences should start with an uppercase letter.
  • Avoid the passive form: i.e., use "change" instead of "changed".

Here is an example for such a message: 

org-capture.el: Fix the case of using a template file

* lisp/org-capture.el (org-capture-set-plist): Make sure txt is a
string before calling `string-match'.
(org-capture-templates): Fix customization type.

* doc/org.texi (Capture): Document using a file for a template.

The problem here was that a wrong keyword was given in the
customization type.  This let to a string-match against a list value.

Modified from a patch proposal by Johan Friis.

TINYCHANGE

If you are using magit in Emacs, the Chan= geLog for such entries can be produced by pressing C (for magit-commit-add-log)= on the diff chunks of a staged file. (If you prefer storing your ChangeLog entries in a file, you can also use C-x 4 a (magit-add-change-log-entry-other-window) from within magit di= splay of diff chunks.)

Another option to produce the entries is to use C-x 4 a in the= changed function or the diff listing. This creates entries in the ChangeLog file and you can then cut and paste these to the commit message and remove the indentation.

Further reference:

Dealing with copyright when contributing to Org mode

All Elisp Org files are also distributed as part of GNU Emacs, they are all copyrighted by the Free Software Fou= ndation, Inc.

If you consider contributing to these files, your need to grant the right to include your works in GNU Emacs to the FSF. For this, you need to complete = this form, and to send it to assign@g= nu.org.

The FSF will send you the assignment contract that both you and the FSF will sign. Please let the Org mode maintainer know when this process is complete.

If you want to learn more about why copyright assignments are collected, read this: Why the FSF gets copyright assignments from contributors?

By submitting patches to emacs-orgmode@gnu.org or by pushing c= hanges to Org's core files, you are placing these changes under the same licensing terms as those under which GNU Emacs is published. 

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

If at the time you submit or push these changes you do have active copyright assignment papers with the FSF, for future changes to either Org mode or to Emacs, this means that copyright to these changes is automatically transferred to the FSF.

The Org mode repository is seen as upstream repository for Emacs, anything contained in it can potentially end up in Emacs.=20=20

Current contributors

You can check current contributors on this pa= ge.

Footnotes:

1

grep -lv "^;; Maintainer:" `find ./lisp -name "*.el"` | less

2

Your total contribution (all patches you submit) should change less than 15 lines. See the CONTRIBUTE file in GNU Emacs. If you contribute more, you have to assign the copyright of your contribution to the Free Softw= are Foundation.

Author: Worg people

Created: 2021-10-08 Fri 15:12

Validate

--=-=-=--