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.cz.  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 lisp directory of the repository
  45      - org.texi, orgcard.tex in the doc directory
  46      - the corresponding ChangeLog files
  47
  48    - Before making any significant changes, please explain and
  49      discuss them on the mailing list emacs-orgmode@gnu.org.
  50
  51      This does obviously not apply to people who are maintaining
  52      their own contributions to Org-mode.  Please, just use the
  53      new mechanism to make sure all changes end up in the right
  54      place.
  55
  56    - Creating and pushing a change to the Org-mode core requires
  57      you also to provide ChangeLog entries.  Just press `C-x 4 a'
  58      in each function or variable you have modified and describe
  59      the change you made in the ChangeLog buffer/file.
  60
  61    - Among other things, Org-mode is widely appreciated because
  62      of its simplicity, cleanness and consistency.  We should try
  63      hard to preserve this and I would like to ask everyone to
  64      keep this in mind when developing changes.
  65
  66
  67 * The contrib directory
  68
  69 The git repository contains a contrib directory.  This directory
  70 is the playing field for any developer, also people who have not
  71 (yet) signed the papers with the FSF.  You are free to add files
  72 to this directory, implementing extensions, new link types etc.
  73 Also non-Lisp extensions like scripts to process Org-mode files
  74 in different ways are welcome in this directory.  You should
  75 provide documentation with your extensions, at least in the form
  76 of commentary in the file, better on worg.  Please discuss your
  77 extensions on emacs-orgmode@gnu.org.
  78
  79 After files have been tested in contrib and found to be generally
  80 useful, we may decide to clarify copyright questions and then
  81 move the file into the Org-mode core.  This means they will be
  82 moved up to the root directory and will also eventually be added
  83 to Emacs bzr repository.  The final decision about this rests
  84 with the maintainer.
  85