1 #+TITLE: How to contribute to Org?
3 #+EMAIL: mdl AT imapmail DOT org
4 #+OPTIONS: H:3 num:nil toc:t \n:nil ::t |:t ^:nil -:t f:t *:t tex:t d:(HIDE) tags:not-in-toc
5 #+STARTUP: align fold nodlcheck hidestars oddeven lognotestate
6 #+SEQ_TODO: TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
7 #+TAGS: Write(w) Update(u) Fix(f) Check(c)
12 # This file is the default header for new Org files in Worg. Feel free
13 # to tailor it to your needs.
15 [[file:index.org][{Back to Worg's index}]]
17 * Types of contributions
19 :CUSTOM_ID: types-of-contributions
22 Every contribution to Org is very welcome. Here is a list of areas
23 where your contribution will be useful:
25 - *bug reports* :: Before sending a bug report, make sure you have read
26 this section of Org's manual: [[https://orgmode.org/org.html#Feedback][Feedback]] You can also read this great
27 text: "[[http://www.chiark.greenend.org.uk/~sgtatham/bugs.html][How to Send Bug Reports Effectively]]"
29 - *patches* :: You can submit patches to the mailing list. See the [[For Org contributors: preferred way of submitting
30 patches][Preferred way of submitting patches]] section for details.
31 You can run =make test= to check that your patch does not introduce new bugs.
33 If your patch is against a file that is part of Emacs, then your
34 total contribution (all patches you submit) should change /less than
35 15 lines/ (See the [[http://git.savannah.gnu.org/cgit/emacs.git/tree/CONTRIBUTE][CONTRIBUTE file in GNU Emacs]].) If you contribute
36 more, you have to assign the copyright of your contribution to the
37 Free Software Foundation (see below).
39 - material to the *Worg* website :: This website is made of Org files
40 that you can contribute to. Learn what Worg is [[file:worg-about.org][about]] and how to
41 contribute to it [[file:worg-git.org][through git]].
43 - *feature requests* :: Org is already mature, but new ideas keep
44 popping up. If you want to request a feature, first dig into the
45 mailing list to find similar proposals. If you cannot find any,
46 subscribe to [[file:org-mailing-list.org][the mailing list]], read it for a while, then make your
47 proposal. Formulate it as detailed as possible, if possible with
50 - Org *add-ons* :: there are many Org add-ons.
51 - The best way is to submit your code to [[file:org-mailing-list.org][the mailing list]] to discuss
53 - If it is useful, you might consider contributing it to the
54 =lisp/contrib/= directory in the git repository. It will be
55 reviewed, and if it passes, it will be included. The
56 =lisp/contrib/= directory is somehow relaxed: it is not distributed
57 with Emacs, and does not require a formal copyright assignment.
58 - If you decide to sign the [[*Copyright issues when contributing to Emacs Org mode][assignment contract with the FSF]], we
59 might include your contribution in the distribution, and then in
62 * Copyright issues when contributing to Emacs Org mode
64 :CUSTOM_ID: copyright-issues
67 Org is made of many files. Most of them are also distributed as part
68 of GNU Emacs. These files are called the /Org core/, and they are all
69 copyrighted by the [[http://www.fsf.org][Free Software Foundation, Inc]].
71 If you consider contributing to these files, your first need to grant
72 the right to include your works in GNU Emacs to the FSF. For this you
73 need to complete [[https://orgmode.org/request-assign-future.txt][this form]], and send it to [[mailto:assign@gnu.org][assign@gnu.org]].
75 The FSF will send you the assignment contract that both you and the
76 FSF will sign. Please let the Org mode maintainer know when this
79 If you want to learn more about /why/ copyright assignments are
80 collected, read this: [[http://www.gnu.org/licenses/why-assign.html][Why the FSF gets copyright assignments from
83 By submitting patches to =emacs-orgmode@gnu.org= or by pushing changes
84 to Org's core files, you are placing these changes under the same
85 licensing terms as those under which GNU Emacs is published.
88 ;; GNU Emacs is free software: you can redistribute it and/or modify
89 ;; it under the terms of the GNU General Public License as published by
90 ;; the Free Software Foundation, either version 3 of the License, or
91 ;; (at your option) any later version.
94 If at the time you submit or push these changes you do have active
95 copyright assignment papers with the FSF, for future changes to either
96 Org mode or to Emacs, this means that copyright to these changes is
97 automatically transferred to the FSF.
99 The Org mode repository is seen as upstream repository for Emacs,
100 anything contained in it can potentially end up in Emacs. If you do
101 not have signed papers with the FSF, only changes to files in the
102 =contrib/= part of the repository will be accepted, as well as very
103 minor changes (so-called /tiny changes/) to core files. We will ask you
104 to sign FSF papers at the moment we attempt to move a =contrib/= file
105 into the Org core, or into Emacs.
114 Please read Worg's page on [[https://orgmode.org/worg/org-maintainance.html][Org maintainance]].
116 ** Pushing your first commit
118 1. Send [[mailto:bzgATgnuDOTorg][Bastien]] the username you want for https://code.orgmode.org
119 2. Add your public key to the account
120 3. Clone =org-mode.git=: =~$ git clone git@code.orgmode.org:bzg/org-mode.git=
121 4. Commit your changes against the code and the documentation.
123 6. If the tests pass, push your changes.
125 If you are undertaking big changes, please create a dedicated branch
126 and make sure you have a clean commit history before merging it into
127 the maint or master branch.
129 * For Org contributors: preferred way of submitting patches
134 ** Coding conventions
136 Org is part of Emacs, so any contribution should follow the [[http://www.gnu.org/software/emacs/manual/html_node/elisp/Coding-Conventions.html][GNU Emacs
137 Lisp coding conventions]] described in Emacs manual.
139 ** Sending patch with git
141 Org mode is developed using /git/ as the version control system.
143 Please use Git to make patches and send them via email -- this is
144 perfectly fine for major and minor changes.
146 When sending a patch (either using =git diff= or =git format-patch=)
147 please *always add a properly formatted Emacs ChangeLog entry*. See
148 [[#commit-messages][this section]] for details on how to create such a ChangeLog.
152 For every patch you send, we suggest to use =git format-patch=.
154 This is easy for small patches and more consequent ones. Sometimes,
155 you might even want to work in several steps and send each commit
156 separately. Here is the suggested workflow:
159 : ~$ git pull # make sure your repo is up to date
160 : ~$ git branch my-changes # create a new branch from master
161 : ~$ git checkout my-changes # switch to this new branch
163 ... make some changes (1) ...
165 : ~$ git commit -a -m "This is change (1)" # Commit your change
167 ... make another change (2) ...
169 : ~$ git commit -a -m "This is change (2)" # Commit your change
170 : ~$ git format-patch master # Creates two patches
172 ... Then two patches for your two commits are ready to be sent to
176 Write useful commit messages: please provide 1) a reason for it in
177 your email and 2) a ChangeLog entry in the commit message (see [[#commit-messages][this
178 section]] on how to format a ChangeLog entry.)
180 ** Sending quick fixes for testing purpose
182 If you want to send a quick fix that needs to be further tested by
183 other people (before you submit a real patch), here is how you can do:
186 This command will make a patch between the staging area (in your
187 computer), and the file you modified:
189 : git diff -p org-whatever.el > org-whatever.el.diff
191 If you already committed your changes to your index (staging area), then
192 you should compare against a particular branch (in this example,
195 : git diff -p origin/master org-whatever.el > org-whatever.el.diff
197 You email the output to the mailing list, adding =[PATCH]= to the
198 subject, and description of what you fixed or changed.
201 Note that small patches sent like this still need to have a ChangeLog
202 entry to be applied. If your patch looks good to you, it's always
203 better to send a patch through =git format-patch=.
205 ** Sharing changes from a public branch
207 When discussing important changes, it is sometimes not so useful to
208 send long and/or numerous patches.
210 In this case, you can maintain your changes on a public branch of a
211 public clone of Org and send a link to the diff between your changes
212 and the latest Org commit that sits in your clone.
214 If the discussion settles and your change is accepted, you can now
215 send it as (a list of) patch(es) to the latest Org version.
217 * Commit messages and ChangeLog entries
219 :CUSTOM_ID: commit-messages
222 We have decided to no longer keep a ChangeLog file to record changes
223 to individual functions.
225 A commit message should be constructed in the following way:
227 - Line 1 of the commit message should always be a short description of
228 the overall change. Line 1 does /not/ get a dot at the end and does
229 not start with a star. Generally, it starts with the filename that
230 has been changed, followed by a colon.
232 - Line 2 is an empty line.
234 - In line 3, the ChangeLog entry should start. A ChangeLog entry
235 looks like [[https://orgmode.org/cgit.cgi/org-mode.git/commit/?id%3Dd49957ef021e256f19092c907d127390d39ec1ed][this]]:
237 : * org-timer.el (org-timer-cancel-timer, org-timer-stop): Enhance
239 : (org-timer-set-timer): Use the number of minutes in the Effort
240 : property as the default timer value. Three prefix arguments will
241 : ignore the Effort value property.
243 - After the changelog, another empty line should come before any
244 additional information that the committer wishes to provide in order
245 to explain the patch.
247 - If the change is a minor change made by a committer without
248 copyright assignment to the FSF, the commit message should also
249 contain the cookie =TINYCHANGE= (anywhere in the message). When we
250 later produce the ChangeLog file for Emacs, the change will be
251 marked appropriately.
253 - Variables and functions names are quoted like `this' (backquote and
256 - Sentences should be separated by two spaces.
258 - Sentences should start with an uppercase letter.
260 - Avoid the passive form: i.e., use "change" instead of "changed".
262 Here is an example for such a message:
265 org-capture.el: Fix the case of using a template file
267 ,* lisp/org-capture.el (org-capture-set-plist): Make sure txt is a
268 string before calling `string-match'.
269 (org-capture-templates): Fix customization type.
271 ,* doc/org.texi (Capture): Document using a file for a template.
273 The problem here was that a wrong keyword was given in the
274 customization type. This let to a string-match against a list value.
276 Modified from a patch proposal by Johan Friis.
281 If you are using /magit.el/ in Emacs, the ChangeLog for such entries are
282 easily produced by pressing =C= in the diff listing.
284 Another option to produce the entries is to use `C-x 4 a' in the
285 changed function or in the diff listing. This will create entries in
286 the ChangeLog file, and you can then cut and paste these to the commit
287 message and remove the indentation.
289 - Further reference: [[http://git.savannah.gnu.org/cgit/emacs.git/plain/CONTRIBUTE][Contribution guide from Emacs repo]]
291 * Copyrighted contributors to Org mode
293 :CUSTOM_ID: copyrighted-contributors
296 Here is the list of people who have contributed actual code to the Org
297 mode core. Note that the manual contains a more extensive list with
298 acknowledgments, including contributed ideas! The lists below are
299 mostly for house keeping, to help the maintainers keep track of
302 ** Current contributors
304 :CUSTOM_ID: contributors_with_fsf_papers
307 Here is the list of people who signed the papers with the Free Software
308 Foundation and can now freely submit code to Org files that are included
325 - Andrzej Lichnerowicz
332 - Barry Leonard Gidden
348 - Christopher Miles Gray
349 - Christopher Schmidt
350 - Christopher Suckling
351 - Clément Pit--Claudel
354 - Daniel M.\nbsp{}Hackney
355 - David Arroyo Menéndez
362 - Emmanuel Charpentier
365 - Eric S.\nbsp{}Fraga
371 - Francesco Pizzolante
374 - George Kettleborough
378 - Grégoire Jadi (aka Daimrod)
380 - Henning Dietmar Weiss
404 - Jonathan Leech-Pepin
406 - José L.\nbsp{}Doménech
415 - Kevin Brubeck Unhammer
424 - Leonard Avery Randall
433 - Mark A.\nbsp{}Hershberger
442 - Miguel A.\nbsp{}Figueroa-Villanueva
458 - Pedro Alexandre Marcelino Costa da Silva
469 - Rasmus Pank Roulund
474 - Robert Michael Irelan
488 - Siraphob Phipathananunth
502 - Thomas S.\nbsp{}Dye
506 - Titus von der Malsburg
521 - Yuri D.\nbsp{}Lensky
523 - Zhuo Qingliang (Killy Draw)
527 These people have been asked to sign the papers, and they are
528 currently considering it or a request is being processed by the FSF.
530 - Felipe Lema [2020-02-25 mar.]
531 - Terje Larsen [2020-02-17 lun.]
532 - Brian Carlson [2016-05-24 Tue]
533 - Mats Kindahl (as of 2013-04-06) for [[http://mid.gmane.org/513BAB7D.1000603@oracle.com][this patch]]
538 These people have submitted tiny change patches that made it into Org
539 without FSF papers. When they submit more, we need to get papers
540 eventually. The limit is a cumulative change of 20 non-repetitive
541 change lines. Details are given in [[http://www.gnu.org/prep/maintain/maintain.html#Legally-Significant ][this document]].
543 - Aaron L.\nbsp{}Zeng
544 - Abhishek Chandratre
556 - Arne Babenhauserheide
566 - Christian Schwarzgruber
583 - Francesco Montanari
588 - Greg Tucker-Kellogg
590 - Ivan Vilata i Balaguer
600 - Joaquín Aguirrezabalaga
609 - Konstantin Kliakhandler
612 - Leslie Harlley Watter
651 - Richard Y.\nbsp{}Kim (Kim)
654 - Robert P.\nbsp{}Goldman
658 - Saulius Menkevičius
659 - Sebastien Le Maguer
666 - Stefan-W.\nbsp{}Hahn
673 - Thomas Alexander Gerds
683 - Xavier Martinez-Hidalgo
688 - Zane D.\nbsp{}Purvis
691 (This list may be incomplete - please help completing it.)
695 These people cannot or prefer to not sign the FSF copyright papers,
696 and we can only accept patches that do not change the core files (the
697 ones that are also in Emacs).
699 Luckily, this list is still empty.
701 #+BEGIN: timestamp :string "Last update: " :format "%Y-%m-%d @ %H:%M"