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 git repository is hosted publicly at Anyone
  8. can get a clone of the current repository state using the
  9. command
  10. git clone 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. People who are interested to participate in the Org-mode
  15. development can do so by sending patches to
  17. 3. An interested developer can also request push access to the
  18. central repository by sending his/her user-info at
  19. the maintainer of Org-mode.
  20. After you have been added as a user with push privileges,
  21. clone the repository through ssh using
  22. git+ssh://
  23. By requesting push access, you acknowledge that you have read
  24. and agreed with the following rules:
  25. - Org-mode is part of Emacs. Therefore, we need to be very
  26. conscious about changes moving into the Org-mode core.
  27. These can originate only from people who have signed the
  28. appropriate papers with the Free Software Foundation. The
  29. files to which this applies are:
  30. - all *.el files in the lisp directory of the repository
  31. - org.texi, orgcard.tex in the doc directory
  32. - the corresponding ChangeLog files
  33. - Before making any significant changes, please explain and
  34. discuss them on the mailing list
  35. This does obviously not apply to people who are maintaining
  36. their own contributions to Org-mode. Please, just use the
  37. new mechanism to make sure all changes end up in the right
  38. place.
  39. - Creating and pushing a change to the Org-mode core requires
  40. you also to provide ChangeLog entries. Just press `C-x 4 a'
  41. in each function or variable you have modified and describe
  42. the change you made in the ChangeLog buffer/file.
  43. - Among other things, Org-mode is widely appreciated because
  44. of its simplicity, cleanness and consistency. We should try
  45. hard to preserve this and I would like to ask everyone to
  46. keep this in mind when developing changes.
  47. * The contrib directory
  48. The git repository contains a contrib directory. This directory
  49. is the playing field for any developer, also people who have not
  50. (yet) signed the papers with the FSF. You are free to add files
  51. to this directory, implementing extensions, new link types etc.
  52. Also non-Lisp extensions like scripts to process Org-mode files
  53. in different ways are welcome in this directory. You should
  54. provide documentation with your extensions, at least in the form
  55. of commentary in the file, better on worg. Please discuss your
  56. extensions on
  57. After files have been tested in contrib and found to be generally
  58. useful, we may decide to clarify copyright questions and then
  59. move the file into the Org-mode core. This means they will be
  60. moved up to the root directory and will also eventually be added
  61. to Emacs bzr repository. The final decision about this rests
  62. with the maintainer.