README_contribute 3.5 KB

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