README_contribute 3.3 KB

  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
  8. Anyone can get a clone of the current repository state using
  9. the command
  10. git clone
  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 in participating to the Org mode
  15. development can do so by sending patches to this address:
  16. [[][]]
  17. 3. An interested developer can also request push access to the
  18. central repository by creating an account on
  19. and by sending her/his user info to the maintainer.
  20. After you have been added as a user with push privileges,
  21. clone the repository through ssh using
  22. git clone
  23. By requesting push access, you acknowledge that you have read
  24. and agreed with the following rules:
  25. - Org mode is part of GNU Emacs. Therefore, we need to be
  26. very 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. - Org mode no longer uses ChangeLog entries to document
  40. changes. Instead, special commit messages are used, as
  41. described in the `CONTRIBUTE' file in the main Emacs
  42. repository.
  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 ask everyone to keep this in mind
  46. 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 files in
  53. different ways are welcome in this directory. You should provide
  54. documentation with your extensions, at least in the form of
  55. 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
  58. generally useful, we may decide to clarify copyright questions
  59. and then move the file into the Org mode core. This means they
  60. will be moved up to the root directory and will also eventually
  61. be added to GNU Emacs git repository. The final decision about
  62. this rests with the maintainer.