Merge branch 'maint'
[org-mode/org-tableheadings.git] / README_contribute
blob69d4e369562338c688e48859cf8f6eae18133213
1   -*- mode: org; fill-column:65 -*-
3 This is the GIT repository for the development of Org mode, an
4 Emacs mode for organizing your life.
6 The text below explains the rules for participating in Org mode
7 development.
9 * Main rules
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
15      git clone https://code.orgmode.org/bzg/org-mode.git
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.
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
24      git clone git://repo.or.cz/org-mode.git
26 3. People who are interested in participating to the Org mode
27    development can do so by sending patches to this address:
29      [[mailto:emacs-orgmode@gnu.org][emacs-orgmode@gnu.org]]
31 4. An interested developer can also request push access to the
32    central repository by creating an account on code.orgmode.org
33    and by sending her/his user info to the maintainer.
35    After you have been added as a user with push privileges,
36    clone the repository through ssh using
38      git clone git@code.orgmode.org:bzg/org-mode.git
40    By requesting push access, you acknowledge that you have read
41    and agreed with the following rules:
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:
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
53    - Before making any significant changes, please explain and
54      discuss them on the mailing list emacs-orgmode@gnu.org.
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.
61    - Org mode no longer uses ChangeLog entries to document
62      changes.  Instead, special commit messages are used, as
63      described in the `CONTRIBUTE' file in the main Emacs
64      repository.
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 ask everyone to keep this in mind
69      when developing changes.
71 * The contrib/ directory
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.
78 Also non-Lisp extensions like scripts to process Org files in
79 different ways are welcome in this directory.  You should provide
80 documentation with your extensions, at least in the form of
81 commentary in the file, better on worg.  Please discuss your
82 extensions on [[mailto:emacs-orgmode@gnu.org][emacs-orgmode@gnu.org]].
84 After files have been tested in =contrib/= and found to be
85 generally useful, we may decide to clarify copyright questions
86 and then move the file into the Org mode core.  This means they
87 will be moved up to the root directory and will also eventually
88 be added to GNU Emacs git repository.  The final decision about
89 this rests with the maintainer.