Skip to content

Commit 252a062

Browse files
committed
CONTRIBUTE.org: Try to be more effective in giving directions
Also link to Worg pages as much as possible because more people can contribute to them.
1 parent c536832 commit 252a062

File tree

1 file changed

+15
-55
lines changed

1 file changed

+15
-55
lines changed

CONTRIBUTE.org

Lines changed: 15 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,26 @@
1-
The text below explains the rules for participating in Org mode
2-
development.
1+
See [[https://orgmode.org/worg/org-contribute.html][the org-contribute page on Worg]] for guidance on how to contribute
2+
effectively.
33

4-
* Org maintenance
4+
We value a nice tone in our discussions: please check and respect the
5+
[[https://www.gnu.org/philosophy/kind-communication.en.html][GNU Kind Communications Guidelines]].
56

6-
Org maintenance is detailed on Worg: see [[https://orgmode.org/worg/org-maintenance.html][org-maintenance]].
7+
* Contribute as a Org user
78

8-
* Main contribution rules
9+
You can contribute by helping others in various channels.
910

10-
1. The master git repository is hosted publicly on [[https://savannah.gnu.org][savannah.gnu.org]].
11+
See [[https://orgmode.org/worg/org-contribute.html#org99b8f3e][these directions]].
1112

12-
: git clone https://git.savannah.gnu.org/git/emacs/org-mode.git
13+
* Contribute as an Emacs Lisp hacker
1314

14-
This is sufficient to start hacking and to produce patches that can
15-
easily and consistently be applied to the main repository.
15+
You can contribute with bug reports and patches.
1616

17-
2. People who want to participate to the Org mode development can send
18-
patches to this address:
17+
See these [[https://orgmode.org/worg/org-contribute.html#org069b83a][directions]].
1918

20-
: emacs-orgmode@gnu.org
19+
* As a Org maintainer
2120

22-
3. If you are a regular contributor, you can request push access to
23-
the repository by creating an account on [[https://savannah.gnu.org/account/register.php][savannah.gnu.org]] and by
24-
[[https://savannah.gnu.org/git/?group=emacs][joining the Emacs group]].
25-
26-
After you have been added as a user with push privileges, you can
27-
clone the repository like this:
21+
We encourage you to volunteer to maintain one of the Org files.
2822

29-
: git clone USERNAME@git.savannah.gnu.org:/srv/git/emacs/org-mode.git
23+
Just [[mailto:emacs-orgmode@gnu.org][send an email to the list]] explaining which file and your
24+
motivations.
3025

31-
Replace =USERNAME= with your Savannah username.
32-
33-
4. By requesting push access, you acknowledge that you have read and
34-
agreed with the following rules:
35-
36-
- Org mode is part of GNU Emacs. Therefore, we need to be very
37-
conscious about changes moving into the Org mode core. These can
38-
originate only from people who have signed the appropriate papers
39-
with the Free Software Foundation. The files to which this
40-
applies are:
41-
42-
- all *.el files in the lisp directory of the repository
43-
- orgcard.tex and all *.org files in the doc/ directory
44-
45-
- Before making any significant changes, please explain and discuss
46-
them on the mailing list [[mailto:emacs-orgmode@gnu.org][emacs-orgmode@gnu.org]].
47-
48-
This does obviously not apply to people who are maintaining their
49-
own contributions to Org mode. Please just use the new mechanism
50-
to make sure all changes end up in the right place.
51-
52-
We value a nice tone in our discussions: please check and respect
53-
the [[https://www.gnu.org/philosophy/kind-communication.en.html][GNU Kind Communications Guidelines]].
54-
55-
- Org mode no longer uses ChangeLog entries to document changes.
56-
Instead, special commit messages are used. The commit message
57-
format generally follows Emacs conventions, as described in the
58-
`CONTRIBUTE' file in the main Emacs repository. Several more
59-
Org-specific conventions are described in
60-
[[https://orgmode.org/worg/org-contribute.html#commit-messages][worg/org-contribute#commit-messages]].
61-
62-
- Among other things, Org mode is widely appreciated because of its
63-
simplicity, cleanness and consistency. We should try to preserve
64-
them and ask everyone to keep this in mind when posting changes.
65-
66-
See [[https://orgmode.org/worg/org-contribute.html][worg/org-contribute]] for guidance on how to contribute effectively.
26+
See what is [[https://orgmode.org/worg/org-maintenance.html][the role of a maintainer]].

0 commit comments

Comments
 (0)