CONTRIBUTE 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. The text below explains the rules for participating in Org mode
  2. development.
  3. * Org maintenance
  4. Org maintenance is explained on Worg: see [[https://orgmode.org/worg/org-maintenance.html][org-maintenance]].
  5. * Main contribution rules
  6. 1. The master git repository is hosted publicly at [[https://orgmode.org][orgmode.org]].
  7. Anyone can get a clone of the current repository state using the
  8. command
  9. : git clone https://code.orgmode.org/bzg/org-mode.git
  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 this address:
  15. : emacs-orgmode@gnu.org
  16. 3. An interested developer can also request push access to the central
  17. repository by creating an account on code.orgmode.org and by
  18. sending her/his user info to the maintainer.
  19. After you have been added as a user with push privileges, clone the
  20. repository through ssh using
  21. : git clone git@code.orgmode.org:bzg/org-mode.git
  22. By requesting push access, you acknowledge that you have read and
  23. agreed with the following rules:
  24. - Org mode is part of GNU Emacs. Therefore, we need to be very
  25. conscious about changes moving into the Org mode core. These can
  26. originate only from people who have signed the appropriate papers
  27. with the Free Software Foundation. The files to which this
  28. applies are:
  29. - all *.el files in the lisp directory of the repository
  30. - org.texi, orgcard.tex in the doc directory
  31. - the corresponding ChangeLog files
  32. - Before making any significant changes, please explain and discuss
  33. them on the mailing list [[mailto:emacs-orgmode@gnu.org][emacs-orgmode@gnu.org]].
  34. This does obviously not apply to people who are maintaining their
  35. own contributions to Org mode. Please, just use the new mechanism
  36. to make sure all changes end up in the right place.
  37. We value a nice tone in our discussions: please check and respect
  38. the [[https://www.gnu.org/philosophy/kind-communication.en.html][GNU Kind Communications Guidelines]].
  39. - Org mode no longer uses ChangeLog entries to document changes.
  40. Instead, special commit messages are used, as described in the
  41. `CONTRIBUTE' file in the main Emacs repository.
  42. - Among other things, Org mode is widely appreciated because of its
  43. simplicity, cleanness and consistency. We should try hard to
  44. preserve this and ask everyone to keep this in mind when
  45. proposing changes.
  46. See [[https://orgmode.org/worg/org-contribute.html][worg/org-contribute]] for more guidance on how to contribute
  47. effectively.
  48. * The =contrib/= directory
  49. The git repository used to contain a =contrib/= directory, which was
  50. moved to https://git.sr.ht/~bzg/org-contrib before Org 9.5, which see.