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 This file 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 be 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. Any interested developer can request push access to the
  27    repository by sending their repo.or.cz user information to the
  28    maintainer of Org-mode.  By requesting push access, you
  29    acknowledge that you have read and agreed with the following
  30    rules:
  31
  32    - Org-mode is part of Emacs.  Therefore we need to be very
  33      conscious that any changes moving into the Org-mode core are
  34      done only by people who have signed the appropriate papers
  35      with the free software foundation.  The files to which this
  36      applies are:
  37
  38      - all *.el files in the root directory of the repository
  39      - org.texi, orgcard.tex, and ChangeLog.
  40
  41    - Before making any significant changes, please explain and
  42      discuss them on the mailing list emacs-orgmode@gnu.org.
  43
  44      This does obviously not apply to people like Bastien Guerry,
  45      David O'Toole, Piotr Zielinski, or anyone else who has
  46      contributed and still maintains a file that is part of
  47      Org-mode.  Please, just use the new mechanism to make sure
  48      all changes end in the right place.
  49
  50    - Making and pushing a change to the Org-mode core requires
  51      you also to provide ChangeLog entries.  Just press `C-x 4 a'
  52      in each function or variable you have modified and describe
  53      the change you made in the ChangeLog buffer/file.  This is
  54      important, because these entries will be required when
  55      uploading any new version into the Emacs CVS tree.
  56
  57    - Among other things, Org-mode is widely appreciated because
  58      if its simplicity, cleanness and consistency.  We should try
  59      hard to preserve this and I would like to ask everyone to
  60      keep this in mind when developing changes.
  61
  62 * The CONTRIB directory
  63
  64 The git repository contains a CONTRIB directory.  This directory
  65 is the playing field for any developer, also people who have not
  66 (yet) signed the papers with the FSF.  You are free to add files
  67 to this directory, implementing extensions, new link types etc.
  68 Also non-Lisp extensions like scripts to process Org-mode files
  69 in different ways are welcome in this directory.  You should
  70 provide documentation with your extensions, at least in the form
  71 of commentary in the file.  Please discuss your extensions on
  72 emacs-orgmode@gnu.org.
  73
  74 The CONTRIB directory will be part of the Org-mode distribution
  75 starting with version 6.0 (the first release after 5.20).  When
  76 that happens, people who want to use extensions will have to make
  77 sure their search path (executable or Lisp) includes the relevant
  78 directories.
  79
  80 After files have been tested in CONTRIB and found to be generally
  81 useful, we may decide to clarify copyright questions and then
  82 move the file into the Org-mode core.  This means they will be
  83 moved up to the root directory and will also eventually be added
  84 to Emacs CVS tree.  The final decision about this rests with the
  85 maintainer.