README_GIT

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