1. -*- mode: org; fill-column:70 -*-
  2. The text below explains the rules for participating in Org mode
  3. development.
  4. * Org maintenance
  5. Org maintenance is explained on Worg: see [[][org-maintenance]].
  6. * Main contribution rules
  7. 1. The master git repository is hosted publicly at [[][]].
  8. Anyone can get a clone of the current repository like this:
  9. : git clone
  10. Having a clone is sufficient to start hacking and to produce
  11. patches that can easily and consistently be applied to the main
  12. repository.
  13. 2. People who are interested in participating to the Org mode
  14. development can do so by sending patches to the mailing list:
  15. :
  16. 3. An interested developer can also request push access to the
  17. repository by sending an email to the maintainer to request an
  18. account on
  19. After you have been added as a user with push privileges:
  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. See [[][worg/org-contribute]] for more guidance on how to contribute
  46. effectively.
  47. * The =contrib/= directory
  48. The git repository used to contain a =contrib/= directory. Files in
  49. this directory where moved to a new [[][org-contrib]] repository before Org
  50. 9.5. You can install the new =org-contrib= from [[][NonGNU ELPA]].