1. -*- mode: org; fill-column:70 -*-
  2. The text below explains the rules for participating in Org mode
  3. development.
  4. * Main contribution rules
  5. 1. The master git repository is hosted publicly at [[][]].
  6. Anyone can get a clone of the current repository state using the
  7. command
  8. : git clone
  9. Having a clone is sufficient to start hacking and to produce
  10. patches that can easily and consistently be applied to the main
  11. repository.
  12. 2. People who are interested in participating to the Org mode
  13. development can do so by sending patches to this address:
  14. :
  15. 3. An interested developer can also request push access to the central
  16. repository by creating an account on and by
  17. sending her/his user info to the maintainer.
  18. After you have been added as a user with push privileges, clone the
  19. repository through ssh using
  20. : git clone
  21. By requesting push access, you acknowledge that you have read and
  22. agreed with the following rules:
  23. - Org mode is part of GNU Emacs. Therefore, we need to be very
  24. conscious about changes moving into the Org mode core. These can
  25. originate only from people who have signed the appropriate papers
  26. with the Free Software Foundation. The files to which this
  27. applies are:
  28. - all *.el files in the lisp directory of the repository
  29. - org.texi, orgcard.tex in the doc directory
  30. - the corresponding ChangeLog files
  31. - Before making any significant changes, please explain and discuss
  32. them on the mailing list [[][]].
  33. This does obviously not apply to people who are maintaining their
  34. own contributions to Org mode. Please, just use the new mechanism
  35. to make sure all changes end up in the right place.
  36. We value a nice tone in our discussions: please check and respect
  37. the [[][GNU Kind Communications Guidelines]].
  38. - Org mode no longer uses ChangeLog entries to document changes.
  39. Instead, special commit messages are used, as described in the
  40. `CONTRIBUTE' file in the main Emacs repository.
  41. - Among other things, Org mode is widely appreciated because of its
  42. simplicity, cleanness and consistency. We should try hard to
  43. preserve this and ask everyone to keep this in mind when
  44. proposing changes.
  45. * The contrib/ directory
  46. The git repository contains a =contrib/= directory. This directory is
  47. the playing field for any developer, also people who have not (yet)
  48. signed the papers with the FSF. You are free to add files to this
  49. directory, implementing extensions, new link types etc.
  50. Also non-Lisp extensions like scripts to process Org files in different
  51. ways are welcome in this directory. You should provide documentation
  52. with your extensions, at least in the form of commentary in the file,
  53. better on worg. Please discuss your extensions on
  54. [[][]].
  55. After files have been tested in =contrib/= and found to be generally
  56. useful, we may decide to clarify copyright questions and then move the
  57. file into the Org mode core. This means they will be moved up to the
  58. root directory and will also eventually be added to GNU Emacs git
  59. repository. The final decision about this rests with the maintainer.
  60. * Org maintainance
  61. Org maintainance is explained on Worg: see [[][org-maintainance]].