1
0
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-12-05 08:53:36 +00:00
org-mode/README_GIT

92 lines
3.4 KiB
Plaintext
Raw Normal View History

2008-02-06 12:32:20 +00:00
-*- mode: org; fill-column:65 -*-
This is the GIT repository for the development of Org-mode, an
Emacs mode for organizing your life.
The text below explains the rules for participating in Org-mode
2008-02-06 12:32:20 +00:00
development.
* Main rules
2011-07-08 15:22:21 +00:00
1. The master git repository is hosted publicly at orgmode.org.
Anyone can get a clone of the current repository state using
the command
2008-02-06 12:32:20 +00:00
2011-07-08 15:22:21 +00:00
git clone git://orgmode.org/org-mode.git
2008-02-06 12:32:20 +00:00
Having a clone is sufficient to start hacking and to produce
patches that can easily and consistently be applied to the
2008-02-06 12:32:20 +00:00
main repository.
2011-07-08 15:22:21 +00:00
2. There is a mirror hosted publicly at repo.or.cz. Anyone can
get a clone of the current repository state using the command
git clone git://repo.or.cz/org-mode.git
3. People who are interested to participate in the Org-mode
development can to so by sending patches to this address:
emacs-orgmode@gnu.org
2008-02-06 12:32:20 +00:00
2011-07-08 15:22:21 +00:00
4. An interested developer can also request push access to the
central repository by sending her/his user-info to the
maintainer of Org-mode or the webmaster of orgmode.org.
2008-02-18 07:14:38 +00:00
After you have been added as a user with push privileges,
clone the repository through ssh using
2011-07-08 15:22:21 +00:00
git clone orgmode@orgmode.org:org-mode.git
2008-02-18 07:14:38 +00:00
By requesting push access, you acknowledge that you have read
and agreed with the following rules:
2008-02-06 12:32:20 +00:00
2010-04-14 13:52:13 +00:00
- Org-mode is part of Emacs. Therefore, we need to be very
conscious about changes moving into the Org-mode core.
These can originate only from people who have signed the
2008-02-18 07:14:38 +00:00
appropriate papers with the Free Software Foundation. The
files to which this applies are:
2008-02-06 12:32:20 +00:00
2010-04-14 13:52:13 +00:00
- all *.el files in the lisp directory of the repository
- org.texi, orgcard.tex in the doc directory
- the corresponding ChangeLog files
2008-02-06 12:32:20 +00:00
- Before making any significant changes, please explain and
discuss them on the mailing list emacs-orgmode@gnu.org.
This does obviously not apply to people who are maintaining
their own contributions to Org-mode. Please, just use the
new mechanism to make sure all changes end up in the right
place.
2008-02-06 12:32:20 +00:00
- Creating and pushing a change to the Org-mode core requires
2008-02-06 12:32:20 +00:00
you also to provide ChangeLog entries. Just press `C-x 4 a'
in each function or variable you have modified and describe
the change you made in the ChangeLog buffer/file.
2008-02-06 12:32:20 +00:00
- Among other things, Org-mode is widely appreciated because
2010-04-14 13:52:13 +00:00
of its simplicity, cleanness and consistency. We should try
2008-02-06 12:32:20 +00:00
hard to preserve this and I would like to ask everyone to
keep this in mind when developing changes.
2010-04-14 13:52:13 +00:00
* The contrib directory
2008-02-06 12:32:20 +00:00
2010-04-14 13:52:13 +00:00
The git repository contains a contrib directory. This directory
2008-02-06 12:32:20 +00:00
is the playing field for any developer, also people who have not
(yet) signed the papers with the FSF. You are free to add files
to this directory, implementing extensions, new link types etc.
Also non-Lisp extensions like scripts to process Org-mode files
in different ways are welcome in this directory. You should
provide documentation with your extensions, at least in the form
2010-04-14 13:52:13 +00:00
of commentary in the file, better on worg. Please discuss your
extensions on emacs-orgmode@gnu.org.
2008-02-06 12:32:20 +00:00
2010-04-14 13:52:13 +00:00
After files have been tested in contrib and found to be generally
2008-02-06 12:32:20 +00:00
useful, we may decide to clarify copyright questions and then
move the file into the Org-mode core. This means they will be
moved up to the root directory and will also eventually be added
2010-04-14 13:52:13 +00:00
to Emacs bzr repository. The final decision about this rests
with the maintainer.