README_contribute

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