org-contribute.org 21 KB

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: [[https://orgmode.org/org.html#Feedback][Feedback]] You can also read this great text: "[[http://www.chiark.greenend.org.uk/~sgtatham/bugs.html][How to Send Bug Reports Effectively]]"
  • 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 [[https://orgmode.org/worg/org-issues.html][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 patches -- You can submit patches to the mailing
  • list. See the [[For Org contributors: preferred way of submitting patches][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 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 [[file:org-people.org][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 [[*Copyright issues when contributing to
  • Emacs Org mode][assignment contract with the FSF]], we might include your contribution in the distribution, and then in GNU Emacs.
  • you can submit material to the Worg website -- This website is
  • made of Org files that you can contribute to. Learn what Worg is [[file:worg-about.org][about]] and how to contribute to it [[file:worg-git.org][through git]].

Copyright issues when contributing to Emacs Org mode

Org is made of many files. Most of them are also distributed as part of GNU Emacs. These files are called the Org core, and they are all copyrighted by the Free Software Foundation, Inc. If you consider contributing to these files, your first need to grant the right to include your works in GNU Emacs to the FSF. For this you need to complete this form, and send it to assign@gnu.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. Some people consider this assignment process a hassle. I don't want to discuss this in detail here - there are some good reasons for getting the copyright registered, an example is discussed in this FLOSS weekly podcast. Furthermore, by playing according to the Emacs rules, we gain the fantastic advantage that every version of Emacs ships with Org-mode already fully built in. So please consider doing this - it makes our work as maintainers so much easier, because we can then take your patches without any additional work.

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 changes to the Org-mode repository, 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. If you do not have signed papers with the FSF, only changes to files in the contrib/ part of the repository will be accepted, as well as very minor changes (so-called /tiny changes/) to core files. We will ask you to sign FSF papers at the moment we attempt to move a contrib/ file into the Org core, or into Emacs.

For Org developers

:PROPERTIES: :CUSTOM_ID: devs :END:

  1. Send your public key to Bastien
  1. Wait for confirmation that your public key has been added to the
  2. server.

  • Clone org-mode.git repository like this:
    1. ~$ git clone orgmode@orgmode.org:org-mode.git
      
    1. Commit your changes.
    1. Run make test
    1. If the tests pass, push your changes.

    If you are undertaking big changes, please create a dedicated branch for them.

    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.
    2. 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.

    1. Create a repository that can be publicly accessed, for example on
    2. /GitHub/, /repo.or.cz/, or on your own server.
    1. Push your topic branches (and optionally the master branch) to your
    2. 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
    
    1. Do your work on topic-specific branches, using a branch name that
    2. relates to what you are working on.
    1. Often do

    git remote update

    to pull commits from all defined remote repositories, in particular the org-mode master at repo.or.cz.

    1. When you have something workable, publish the git path and branch
    2. name on the mailing list, so that people can test it and review your work.
    1. After your topic has been merged to the project master branch you
    2. 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 [[https://orgmode.org/cgit.cgi/org-mode.git/commit/?id%3Dd49957ef021e256f19092c907d127390d39ec1ed][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

    :PROPERTIES: :CUSTOM_ID: contributors_with_fsf_papers :END:

    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. Abdó Roig-Maranges
    3. Achim Gratz
    4. Adam Elliott
    5. Adam Porter
    6. Adam Spiers
    7. Alan Schmitt
    8. Alex Branham
    9. Alexey Lebedeff
    10. Andreas Burtzlaff
    11. Andreas Leha
    12. Andrew Hyatt
    13. Andrzej Lichnerowicz
    14. Andy Steward
    15. Anthony John Day
    16. Anthony Lander
    17. Arni Magnusson
    18. Arun Isaac
    19. Baoqiu Cui
    20. Barry Leonard Gidden
    21. Bastien Guerry
    22. Benjamin Andresen
    23. Bernd Grobauer
    24. Bernt Hansen
    25. Brian James Gough
    26. Brice Waegenire
    27. Carsten Dominik
    28. Charles Berry
    29. Charles Sebold
    30. Christian Egli
    31. Christian Garbs
    32. Christian Moe
    33. Christopher League
    34. Christopher Miles Gray
    35. Christopher Schmidt
    36. Christopher Suckling
    37. Clément Pit--Claudel
    38. Dan Davison
    39. Daniel M German
    40. Daniel M. Hackney
    41. David Arroyo Menéndez
    42. David Maus
    43. David O'Toole
    44. Dieter Schoen
    45. Dima Kogan
    46. Dmitry Antipov
    47. Don March
    48. Eric Abrahamsen
    49. Eric S. Fraga
    50. Eric Schulte
    51. Erik Hetzner
    52. Erik Iverson
    53. Ethan Ligon
    54. Feng Shu
    55. Florian Lindner
    56. Francesco Pizzolante
    57. Frederick Giasson
    58. Gary Oberbrunner
    59. Georg Lehner
    60. George Kettleborough
    61. Giovanni Ridolfi
    62. Grégoire Jadi (aka Daimrod)
    63. Gustav Wikström
    64. Henning Dietmar Weiss
    65. Ian Barton
    66. Ian Dunn
    67. Ian Kelling
    68. Ilya Shlyakhter
    69. Ippei Furuhashi
    70. Jack Kamm
    71. Jake Romer
    72. James TD Smith
    73. Jan Böcker
    74. Jan Malakhovski
    75. Jarmo Hurri
    76. Jason Riedy
    77. Jay Kamat
    78. Jay Kerns
    79. Jeffrey Ryan Horn
    80. Joe Corneli
    81. Joel Boehland
    82. John Kitchin
    83. John Wiegley
    84. Jon Snader
    85. Jonas Bernoulli
    86. Jonathan Leech-Pepin
    87. José L. Doménech
    88. Juan Pechiar
    89. Julian Gehring
    90. Julien Barnier
    91. Julien Danjou
    92. Justin Gordon
    93. Justus Piater
    94. Karl Fogel
    95. Kaushal Modi
    96. Kodi Arfer
    97. Konstantin Antipin
    98. Kyle Meyer
    99. Lambda Coder
    100. Lawrence Mitchell
    101. Le Wang
    102. Lele Gaifax
    103. Lennart Borgman
    104. Leonard Avery Randall
    105. Luis Anaya
    106. Lukasz Stelmach
    107. Madan Ramakrishnan
    108. Magnus Henoch
    109. Manuel Giraud
    110. Marcin Borkowski
    111. Marco Wahl
    112. Martin Pohlack
    113. Martyn Jago
    114. Matt Lundin
    115. Max Mikhanosha
    116. Michael Albinus
    117. Michael Brand
    118. Michael Gauland
    119. Michael Sperber
    120. Miguel A. Figueroa-Villanueva
    121. Mikael Fornius
    122. Moritz Ulrich
    123. Nathan Neff
    124. Nathaniel Flath
    125. Neil Jerram
    126. Nicholas Dokos
    127. Nicolas Berthier
    128. Nicolas Dudebout
    129. Nicolas Goaziou
    130. Nicolas Richard
    131. Niels Giessen
    132. Nikolai Weibull
    133. Noorul Islam K M
    134. Oleh Krehel
    135. Paul Sexton
    136. Pedro Alexandre Marcelino Costa da Silva
    137. Peter Jones
    138. Phil Hudson
    139. Phil Jackson
    140. Philip Rooke
    141. Pieter Praet
    142. Piotr Zielinski
    143. Puneeth Chaganti
    144. Rafael Laboissière
    145. Rainer M Krug
    146. Rasmus Pank Roulund
    147. Richard Kim
    148. Richard Klinda
    149. Richard Riley
    150. Rick Frankel
    151. Russel Adams
    152. Ryo Takaishi
    153. Rüdiger Sonderfeld
    154. Sacha Chua
    155. Samuel Loury
    156. Sebastian Reuße
    157. Sebastian Rose
    158. Sebastien Vauban
    159. Sergey Litvinov
    160. Seweryn Kokot
    161. Simon Michael
    162. Stephen Eglen
    163. Steven Rémot
    164. Suvayu Ali
    165. T.F. Torrey
    166. Tassilo Horn
    167. Thibault Marin
    168. Thierry Banel
    169. Thomas Baumann
    170. Thomas Holst
    171. Thomas S. Dye
    172. Thorsten Jolitz
    173. Tim Burt
    174. Tim Landscheidt
    175. Titus von der Malsburg
    176. Toby Cubitt
    177. Tokuya Kameshima
    178. Tom Breton
    179. Tomas Hlavaty
    180. Tony Day
    181. Trevor Murphy
    182. Ulf Stegemann
    183. Vitalie Spinu
    184. Yann Hodique
    185. Yasushi Shoji
    186. Yoshinari Nomura
    187. Yuri D. Lensky
    188. Zhang Weize
    189. 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 Jensen
    2. Adam Aviv
    3. Aliaksey Artamonau
    4. Allen Li
    5. Aman Yang
    6. Andrew Burgess
    7. Andy Lutomirski
    8. Anthony Cowley
    9. Arun Persaud
    10. Aurélien Aptel
    11. Austin Walker
    12. Axel Kielhorn
    13. Brian Carlson
    14. Chunyang Xu
    15. Craig Tanis
    16. Derek Feichtinger
    17. Doro Rose
    18. Eduardo Bellani
    19. Eric Danan
    20. Federico Beffa
    21. Feng Zhou
    22. Fernando Varesi
    23. Florian Beck
    24. Francesco Montanari
    25. Galen Menzel
    26. Georgiy Tugai
    27. Greg Tucker-Kellogg
    28. Gregor Zattler
    29. Hiroshi Saito
    30. Ivan Vilata i Balaguer
    31. Jack Henahan
    32. Jacob Gerlach
    33. Jacob Matthews
    34. Jakob Lombacher
    35. Jan Seeger
    36. Jan Seeger
    37. Jason Furtney
    38. Jeff Larson
    39. Joe Hirn
    40. John Foerch
    41. Jon Miller
    42. Jonas Hörsch
    43. Joost Diepenmaat
    44. Jose Robins
    45. Kodi Arfer
    46. Konstantin Kliakhandler
    47. Leslie Harlley Watter
    48. Lixin Chin
    49. Luke Amdor
    50. Marc Ihm
    51. Mario Frasca
    52. Mario Martelli
    53. Marshall Flax
    54. Martin Vuk
    55. Martin Šlouf
    56. Matt Price
    57. Matthew Gidden
    58. Matthew MacLean
    59. Michael O'Connor
    60. Michael Strey
    61. Michael Welle
    62. Michael Weylandt
    63. Michaël Cadilhac
    64. Mike McLean
    65. Miro Bezjak
    66. Moritz Kiefer
    67. Muchenxuan Tong
    68. Myles English
    69. Myq Larson
    70. Nathaniel Nicandro
    71. Nick Gunn
    72. Peter Feigl
    73. Peter Moresi
    74. Philip (Pip Cet)
    75. Renato Ferreira
    76. Richard Hansen
    77. Richard Lawrence
    78. Richard Y. Kim (Kim)
    79. Robert P. Goldman
    80. Roberto Huelga
    81. Ruben Maher
    82. Sami Airaksinen
    83. Saulius Menkevičius
    84. Sebastien Le Maguer
    85. Sergey Gordienko
    86. Stardiviner
    87. Stefan-W. Hahn
    88. Stig Brautaset
    89. Sylvain Chouleur
    90. Teika Kazura
    91. Thierry Pellé
    92. Thomas Alexander Gerds
    93. Thomas Rikl
    94. Tom Hinton
    95. Vicente Vera Parra
    96. Viktor Rosenfeld
    97. Vladimir Lomov
    98. Wojciech Gac
    99. Xavier Martinez-Hidalgo
    100. Xi Shen
    101. York Zhao
    102. Zane D. Purvis
    103. Иван Трусков

    (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.