How to contribute to Org?

Table of Contents

{Back to Worg's index}

Types of contributions

Every contribution to Org is very welcome. Here is a list of areas where your contribution will be useful:

  • you can submit bug reports – Before sending a bug report, make sure you have read this section of Org's manual: Feedback You can also read this great text: "How to Send Bug Reports Effectively"
  • you can submit patches – You can submit patches to the mailing list. See the Preferred way of submitting patches section for details. You can run make test to check that your patch does not introduce new bugs.

    If your patch is against a file that is part of Emacs, then 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 Software Foundation (see below).

  • You can submit material to the Worg website – This website is made of Org files that you can contribute to. Learn what Worg is about and how to contribute to it through git.
  • You can submit feature requests – Org is already mature, but new ideas keep popping up. If you want to request a feature, it might be a good idea to have a look at the current Issue tracking file which captures both bug reports and feature requests. Or dig into the mailing list for possible previous discussions about your idea. If you cannot find back your idea, formulate it as detailed as possible, if possible with examples, and send it to the mailing list.
  • You can submit Org add-ons – there are many Org add-ons.
    • The best way is to submit your code to the mailing list to discuss it with people.
    • If it is useful, you might consider contributing it to the lisp/contrib/ directory in the git repository. It will be reviewed, and if it passes, it will be included. Ask help from Eric Schulte for this step. The lisp/contrib/ directory is somehow relaxed: it is not distributed with Emacs, and does not require a formal copyright assignment.
    • If you decide to sign the assignment contract with the FSF, we might include your contribution in the distribution, and then in GNU Emacs.

For Org developers

Git branches

Please read READMEmaintainer file within Org's repository.

Pushing your first commit

  1. Create an account on https://code.orgmode.org
  2. Add your public key to the account
  3. Ask Bastien to be added as a collaborator on the repository
  4. Clone org-mode.git: ~$ git clone git@code.orgmode.org:bzg/org-mode.git
  5. Commit your changes against the code and the documentation.
  6. Run make test
  7. If the tests pass, push your changes.

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

Taking care of the manual in both branches

  • When you make a change in the master branch, update doc/org-manual.org accordingly.
  • When you make a change in the maint branch, update doc/org.texi in maint and doc/org-manual.org when you merge maint into master.

For Org contributors: preferred way of submitting patches

Coding conventions

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

Sending patch with git

Org-mode is developed using git as the version control system. Git provides an amazing framework to collaborate on a project. Git can be used to make patches and send them via email – this is perfectly fine for major and minor changes.

When sending a patch (either using git diff or git format-patch) please always add a properly formatted Emacs ChangeLog entry. 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.

This is easy for small patches and more consequent ones. Sometimes, you might even want to work in several steps and send each commit separately. Here is the suggested workflow:

~$ git pull                 # make sure your repo is up to date
~$ git branch my-changes    # create a new branch from master
~$ 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 master                # Creates two patches

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

Write useful commit messages: please provide 1) a reason for it in your email and 2) a ChangeLog entry in the commit message (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 how 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/master):

git diff -p origin/master 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

For more significant contributions, the best way to submit patches is through public branches of your repository clone.

  1. Clone our git repository at https://code.orgmode.org/bzg/org-mode. You can clone using any of the commands below.

    git clone git@code.orgmode.org:bzg/org-mode.git
    git clone https://code.orgmode.org/bzg/org-mode.git
    

    The url using the git protocol is preferred. If you are behind a firewall that blocks git://, you can use the https url.

  2. Create a repository that can be publicly accessed, for example on GitHub or on your own server.
  3. Push your topic branches (and optionally the master branch) to your public repository.

    Define a remote for your public repository you push topics to.

    git remote add REMOTE URL-GOES-HERE
    

    Push branches to the remote

    git push REMOTE BRANCH1 [BRANCH2 BRANCH3 ...]
    

    e.g.

    git remote add github ssh://.../     # Done once to define the remote 'github'
    git push github my-topic
    
  4. Do your work on topic-specific branches, using a branch name that relates to what you are working on.
  5. Often do

    git remote update
    

    to pull commits from all defined remote repositories.

  6. When you have something workable, publish the git path and branch name on the mailing list, so that people can test it and review your work.
  7. After your topic has been merged to the project master branch you can delete the topic on your local and remote repositories.

    git branch -d NEWTOPIC
    git push REMOTE :NEWTOPIC
    

The instructions above are generally useful to let people test new features before sending the patch series to the mailing list, but the patches remain the preferred way of receiving contributions.

Commit messages and ChangeLog entries

We have decided to no longer keep a ChangeLog file to record changes to individual functions.

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.
  • Line 2 is an empty line.
  • In line 3, the ChangeLog entry should start. A ChangeLog entry 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, 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 (anywhere in the message). When we later produce the ChangeLog file for Emacs, the change will be marked appropriately.
  • Variables and functions names are quoted like `this' (backquote and 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.el in Emacs, the ChangeLog for such entries are easily produced by pressing C in the diff listing.

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

Copyrighted contributors to Org mode

Here is the list of people who have contributed actual code to the Org-mode core. Note that the manual contains a more extensive list with acknowledgments, including contributed ideas! The lists below are mostly for house keeping, to help the maintainers keep track of copyright issues.

Current contributors

Here is the list of people who signed the papers with the Free Software Foundation and can now freely submit code to Org files that are included within GNU Emacs:

  1. Aaron Ecay
  2. Aaron Jensen
  3. Abdó Roig-Maranges
  4. Achim Gratz
  5. Adam Elliott
  6. Adam Porter
  7. Adam Spiers
  8. Alan Schmitt
  9. Alex Branham
  10. Alexey Lebedeff
  11. Allen Li
  12. Andreas Burtzlaff
  13. Andreas Leha
  14. Andrew Hyatt
  15. Andrzej Lichnerowicz
  16. Andy Steward
  17. Anthony John Day
  18. Anthony Lander
  19. Arni Magnusson
  20. Arun Isaac
  21. Baoqiu Cui
  22. Barry Leonard Gidden
  23. Bastien Guerry
  24. Benjamin Andresen
  25. Bernd Grobauer
  26. Bernt Hansen
  27. Bjarte Johansen
  28. Brian James Gough
  29. Brice Waegenire
  30. Carlos Pita
  31. Carsten Dominik
  32. Charles Berry
  33. Charles Sebold
  34. Christian Egli
  35. Christian Garbs
  36. Christian Moe
  37. Christopher League
  38. Christopher Miles Gray
  39. Christopher Schmidt
  40. Christopher Suckling
  41. Clément Pit–Claudel
  42. Dan Davison
  43. Daniel M German
  44. Daniel M. Hackney
  45. David Arroyo Menéndez
  46. David Maus
  47. David O'Toole
  48. Dieter Schoen
  49. Dima Kogan
  50. Dmitry Antipov
  51. Don March
  52. Emmanuel Charpentier
  53. Eric Abrahamsen
  54. Eric Schulte
  55. Eric S. Fraga
  56. Erik Hetzner
  57. Erik Iverson
  58. Ethan Ligon
  59. Feng Shu
  60. Florian Lindner
  61. Francesco Pizzolante
  62. Frederick Giasson
  63. Gary Oberbrunner
  64. George Kettleborough
  65. Georg Lehner
  66. Giovanni Ridolfi
  67. Grégoire Jadi (aka Daimrod)
  68. Gustav Wikström
  69. Henning Dietmar Weiss
  70. Henry Blevins
  71. Ian Barton
  72. Ian Dunn
  73. Ian Kelling
  74. Ilya Shlyakhter
  75. Ingo Lohmar
  76. Ippei Furuhashi
  77. Jack Kamm
  78. Jake Romer
  79. James TD Smith
  80. Jan Böcker
  81. Jan Malakhovski
  82. Jarmo Hurri
  83. Jason Riedy
  84. Jay Kamat
  85. Jay Kerns
  86. Jeffrey Ryan Horn
  87. Jens Lechtenboerg
  88. Joe Corneli
  89. Joel Boehland
  90. John Kitchin
  91. John Wiegley
  92. Jonas Bernoulli
  93. Jonathan Leech-Pepin
  94. Jon Snader
  95. José L. Doménech
  96. Juan Pechiar
  97. Julian Gehring
  98. Julien Barnier
  99. Julien Danjou
  100. Justin Gordon
  101. Justus Piater
  102. Karl Fogel
  103. Kaushal Modi
  104. Kevin Brubeck Unhammer
  105. Kodi Arfer
  106. Konstantin Antipin
  107. Kyle Meyer
  108. Lambda Coder
  109. Lawrence Mitchell
  110. Lele Gaifax
  111. Lennart Borgman
  112. Leonard Avery Randall
  113. Le Wang
  114. Luis Anaya
  115. Lukasz Stelmach
  116. Madan Ramakrishnan
  117. Magnus Henoch
  118. Manuel Giraud
  119. Marcin Borkowski
  120. Marco Wahl
  121. Mark A. Hershberger
  122. Martin Pohlack
  123. Martyn Jago
  124. Matt Lundin
  125. Max Mikhanosha
  126. Michael Albinus
  127. Michael Brand
  128. Michael Gauland
  129. Michael Sperber
  130. Miguel A. Figueroa-Villanueva
  131. Mikael Fornius
  132. Moritz Ulrich
  133. Nathaniel Flath
  134. Nathan Neff
  135. Neil Jerram
  136. Nicholas Dokos
  137. Nicolas Berthier
  138. Nicolas Dudebout
  139. Nicolas Goaziou
  140. Nicolas Richard
  141. Niels Giessen
  142. Nikolai Weibull
  143. Noorul Islam K M
  144. Oleh Krehel
  145. Paul Sexton
  146. Pedro Alexandre Marcelino Costa da Silva
  147. Peter Jones
  148. Phil Hudson
  149. Philip Rooke
  150. Phil Jackson
  151. Pierre Téchoueyres
  152. Pieter Praet
  153. Piotr Zielinski
  154. Puneeth Chaganti
  155. Rafael Laboissière
  156. Rainer M Krug
  157. Rasmus Pank Roulund
  158. Richard Kim
  159. Richard Klinda
  160. Richard Riley
  161. Rick Frankel
  162. Robert Michael Irelan
  163. Rüdiger Sonderfeld
  164. Russel Adams
  165. Ryo Takaishi
  166. Sacha Chua
  167. Samuel Loury
  168. Sebastian Miele
  169. Sebastian Reuße
  170. Sebastian Rose
  171. Sebastien Vauban
  172. Sergey Litvinov
  173. Seweryn Kokot
  174. Simon Michael
  175. Siraphob Phipathananunth
  176. Stardiviner
  177. Stephen Eglen
  178. Steven Rémot
  179. Suvayu Ali
  180. Tassilo Horn
  181. T.F. Torrey
  182. Thibault Marin
  183. Thierry Banel
  184. Thomas Baumann
  185. Thomas Holst
  186. Thomas S. Dye
  187. Thorsten Jolitz
  188. Tim Burt
  189. Tim Landscheidt
  190. Titus von der Malsburg
  191. Toby Cubitt
  192. Tokuya Kameshima
  193. Tomas Hlavaty
  194. Tom Breton
  195. Tony Day
  196. Toon Claes
  197. Trevor Murphy
  198. Ulf Stegemann
  199. Vitalie Spinu
  200. Vladimir Panteleev
  201. Yann Hodique
  202. Yasushi Shoji
  203. Yoshinari Nomura
  204. Yuri D. Lensky
  205. Zhang Weize
  206. Zhuo Qingliang (Killy Draw)

Processing

These people have been asked to sign the papers, and they are currently considering it or a request is being processed by the FSF.

  • Brian Carlson [2016-05-24 Tue]
  • Bill Wishon
  • Mats Kindahl (as of 2013-04-06) for this patch
  • Georg Lehner (as of 2013-06-27)
  • Kodi Arfer (as of 2013-06-29)

Tiny Changes

These people have submitted tiny change patches that made it into Org without FSF papers. When they submit more, we need to get papers eventually. The limit is a cumulative change of 20 non-repetitive change lines. Details are given in this document.

  1. Aaron L. Zeng
  2. Adam Aviv
  3. Aliaksey Artamonau
  4. Aman Yang
  5. Anders Johansson
  6. Andrew Burgess
  7. Andrew Eggenberger
  8. Andrii Kolomoiets
  9. Andy Lutomirski
  10. Anthony Cowley
  11. Arun Persaud
  12. Aurélien Aptel
  13. Austin Walker
  14. Axel Kielhorn
  15. Brad Knotwell
  16. Brian Carlson
  17. Cheong Yiu Fung
  18. Christian Schwarzgruber
  19. Chunyang Xu
  20. Craig Tanis
  21. Daniel Peres Gomez
  22. Derek Feichtinger
  23. Dima Gerasimov
  24. Dominik Schrempf
  25. Doro Rose
  26. Eduardo Bellani
  27. Eric Danan
  28. Federico Beffa
  29. Feng Zhou
  30. Fernando Varesi
  31. Florian Beck
  32. Francesco Montanari
  33. Galen Menzel
  34. Georgiy Tugai
  35. Gong Qijian
  36. Gregor Zattler
  37. Greg Tucker-Kellogg
  38. Hiroshi Saito
  39. Ivan Vilata i Balaguer
  40. Jack Henahan
  41. Jacob Gerlach
  42. Jacob Matthews
  43. Jakob Lombacher
  44. Jamie Forth
  45. Jan Seeger
  46. Jason Furtney
  47. Jeff Larson
  48. Joaquín Aguirrezabalaga
  49. Joe Hirn
  50. John Foerch
  51. John Lee
  52. Jonas Hörsch
  53. Jon Miller
  54. Joost Diepenmaat
  55. Jose Robins
  56. Kévin Le Gouguec
  57. Kodi Arfer
  58. Konstantin Kliakhandler
  59. Leslie Harlley Watter
  60. Leslie Watter
  61. Lixin Chin
  62. Luke Amdor
  63. Marc Ihm
  64. Mario Frasca
  65. Mario Martelli
  66. Marshall Flax
  67. Martin Šlouf
  68. Martin Vuk
  69. Matthew Gidden
  70. Matthew MacLean
  71. Matt Price
  72. Michaël Cadilhac
  73. Michael O'Connor
  74. Michael Strey
  75. Michael Welle
  76. Michael Weylandt
  77. Mike McLean
  78. Miro Bezjak
  79. Moritz Kiefer
  80. Muchenxuan Tong
  81. Myles English
  82. Myq Larson
  83. Nathaniel Nicandro
  84. Nick Gunn
  85. Peter Feigl
  86. Peter Moresi
  87. Philip (Pip Cet)
  88. Piet van Oostrum
  89. Renato Ferreira
  90. Renato Ferreira
  91. Richard Hansen
  92. Richard Lawrence
  93. Richard Y. Kim (Kim)
  94. Roberto Huelga
  95. Robert P. Goldman
  96. Roger Welsh
  97. Ruben Maher
  98. Sami Airaksinen
  99. Saulius Menkevičius
  100. Sebastien Le Maguer
  101. Sergey Gordienko
  102. Sigmund Tzeng
  103. Stefano Rodighiero
  104. Stefan-W. Hahn
  105. Stig Brautaset
  106. Sylvain Chouleur
  107. Tadashi Hirata
  108. Teika Kazura
  109. Thierry Pellé
  110. Thomas Alexander Gerds
  111. Thomas Plass
  112. Thomas Rikl
  113. Tobias Schlemmer
  114. Tom Hinton
  115. Vicente Vera Parra
  116. Viktor Rosenfeld
  117. Vladimir Lomov
  118. Wojciech Gac
  119. Xavier Martinez-Hidalgo
  120. Xi Shen
  121. York Zhao
  122. Yue Zhu
  123. Zane D. Purvis
  124. Иван Трусков

(This list may be incomplete - please help completing it.)

No FSF assignment

These people cannot or prefer to not sign the FSF copyright papers, and we can only accept patches that do not change the core files (the ones that are also in Emacs).

Luckily, this list is still empty.

Documentation from the orgmode.org/worg/ website (either in its HTML format or in its Org format) is licensed under the GNU Free Documentation License version 1.3 or later. The code examples and css stylesheets are licensed under the GNU General Public License v3 or later.