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 git repository is hosted publicly at repo.or.cs.  Anyone
  13    can get a clone of the current repository state using the
  14    command
  15
  16      git clone git://repo.or.cz/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. People who are interested to participate in the Org-mode
  23    development can do so by sending patches to
  24    emacs-orgmode@gnu.org.
  25
  26 3. An interested developer can also request push access to the
  27    central repository by sending his/her user-info at repo.or.cz
  28    the maintainer of Org-mode.
  29
  30    After you have been added as a user with push privileges,
  31    clone the repository through ssh using
  32
  33         git+ssh://repo.or.cz/srv/git/org-mode.git
  34
  35    By requesting push access, you acknowledge that you have read
  36    and agreed with the following rules:
  37
  38    - Org-mode is part of Emacs.  Therefore we need to be very
  39      conscious about changes moving into the Org-mode core.
  40      These can originate only from people who have signed the
  41      appropriate papers with the Free Software Foundation.  The
  42      files to which this applies are:
  43
  44      - all *.el files in the root directory of the repository
  45      - org.texi, orgcard.tex, and ChangeLog.
  46
  47    - Before making any significant changes, please explain and
  48      discuss them on the mailing list emacs-orgmode@gnu.org.
  49
  50      This does obviously not apply to people who are maintaining
  51      their own contributions to Org-mode.  Please, just use the
  52      new mechanism to make sure all changes end up in the right
  53      place.
  54
  55    - Creating and pushing a change to the Org-mode core requires
  56      you also to provide ChangeLog entries.  Just press `C-x 4 a'
  57      in each function or variable you have modified and describe
  58      the change you made in the ChangeLog buffer/file.
  59
  60    - Among other things, Org-mode is widely appreciated because
  61      if its simplicity, cleanness and consistency.  We should try
  62      hard to preserve this and I would like to ask everyone to
  63      keep this in mind when developing changes.
  64
  65
  66 * The CONTRIB directory
  67
  68 The git repository contains a CONTRIB directory.  This directory
  69 is the playing field for any developer, also people who have not
  70 (yet) signed the papers with the FSF.  You are free to add files
  71 to this directory, implementing extensions, new link types etc.
  72 Also non-Lisp extensions like scripts to process Org-mode files
  73 in different ways are welcome in this directory.  You should
  74 provide documentation with your extensions, at least in the form
  75 of commentary in the file.  Please discuss your extensions on
  76 emacs-orgmode@gnu.org.
  77
  78 The CONTRIB directory will be part of the Org-mode distribution
  79 starting with version 5.21.  When that happens, people who want
  80 to use extensions will have to make sure their search path
  81 (executable or Lisp) includes the relevant directories.
  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 Emacs CVS tree.  The final decision about this rests with the
  88 maintainer.
  89