org-contribute.org

   1 #+OPTIONS:    H:3 num:nil toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
   2 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
   3 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
   4 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
   5 #+TITLE:      How to contribute to Org?
   6 #+AUTHOR:     Worg people
   7 #+EMAIL:      bzg AT altern DOT org
   8 #+LANGUAGE:   en
   9 #+PRIORITIES: A C B
  10 #+CATEGORY:   worg
  11
  12 # This file is the default header for new Org files in Worg.  Feel free
  13 # to tailor it to your needs.
  14
  15 [[file:index.org][{Back to Worg's index}]]
  16
  17 * Types of contributions
  18
  19 Every contribution to Org is very welcome.  Here is a list of areas where
  20 your contribution will be useful:
  21
  22 - you can submit *bug reports* -- Before sending a bug report, make sure
  23   you have read this section of Org's manual: [[http://orgmode.org/org.html#Feedback][Feedback]]
  24
  25 - you can submit *feature requests* -- Org is already mature, but new ideas
  26   keep popping up.  If you want to request a feature, it might be a good
  27   idea to have a look at the current [[http://orgmode.org/todo.html][TODO list]] of Org, or to dig into the
  28   mailing list for possible previous discussions about your idea.
  29
  30 - you can submit *patches* -- You can submit patches to the mailing list.
  31
  32   If your patch is against a file that is part of Emacs, then it won't be
  33   taken unless it is /less than 10 lines/ or you granted the rights on your
  34   works to the Free Software Foundation, Inc.
  35
  36   If your patch is against a file that is not part of Emacs, then it might
  37   be taken without worrying about its length, if the patch is good.
  38
  39 - you can submit Org *add-ons* -- there are many Org add-ons.  The best way
  40   is to submit your code to the mailing list to discuss it with people.  If
  41   it is useful, you might consider contributing it to the =CONTRIB/=
  42   directory in the git repository.
  43
  44 - you can submit material to the *Worg* website -- This website is made of
  45   Org files that you can contribute to.  Learn what Worg is [[file:worg-about.org][about]] and how
  46   to contribute to it [[file:worg-git.org][through git]].
  47
  48 * Contributing to Emacs org-mode
  49
  50 Org is made of several files.  Those who are part of GNU Emacs are
  51 copyrighted by the [[http://www.fsf.org][Free Software Foundation, Inc]].  If you consider
  52 contributing to these files, your first need to grant the right to include
  53 your works in GNU Emacs to the FSF.  For this you need to complete [[http://www.cognition.ens.fr/~guerry/u/request-assign-future.txt][this
  54 form]] and send it to [[mailto:assign@gnu.org][assign@gnu.org]].
  55
  56 If you want to understand /why/, please read this: [[http://www.gnu.org/licenses/why-assign.html][Why the FSF gets
  57 copyright assignments from contributors?]]
  58
  59 * Preferred way of submitting patches
  60
  61 Org-mode is developed using /git/ as the version control system.  Git
  62 provides an amazing framework to collaborate on a project.  Git
  63 can be used to make patches and send them via email - this is fine for
  64 minor changes.  For more significant contributions, the best
  65 way to submit patches is through public branches of your repository
  66 clone.
  67
  68
  69 1. Clone our git repository at =http://repo.or.cz/w/org-mode.git=
  70
  71 2. Create a repository that can be publicly accessed, for example on
  72    /GitHub/, /repo.or.cz/, or on your own server.
  73
  74 3. Push your topic branches (and optionally the master branch) to your
  75    public repository.
  76
  77    Define a remote for your public repository you push topics to.
  78
  79    : git remote add REMOTE URL-GOES-HERE
  80
  81    Push branches to the remote
  82
  83    : git push REMOTE BRANCH1 [BRANCH2 BRANCH3 ...]
  84
  85    e.g.
  86
  87    : git push add github ssh://.../     # Done once to define the remote 'github'
  88    : git push github my-topic
  89
  90 4. Do your work on topic-specific branches, using a branch name that
  91    relates to what you are working on.
  92
  93 5. Often do
  94
  95    : git remote update
  96
  97    to pull commits from all defined remote repositories, in particular
  98    the org-mode master at /repo.or.cz/.
  99
 100 6. When you have something workable, publish the git path and branch
 101    name on the mailing list, so that people can test it and review
 102    your work.
 103
 104 7. After your topic has been merged to the project master branch you
 105    can delete the topic on your local and remote repositories.
 106
 107    : git branch -d NEWTOPIC
 108    : git push REMOTE :NEWTOPIC
 109
 110 * Current contributors
 111
 112 Here is the list of people who signed the papers with the Free Software
 113 Foundation and can now freely submit code to Org files that are included
 114 within GNU Emacs:
 115
 116 - Benjamin Andresen
 117 - Konstantin Antipin
 118 - Ian Barton
 119 - Thomas Baumann
 120 - Jan Hendrik Boecker
 121 - Tom Breton
 122 - Baoqiu Cui
 123 - Sacha Chua
 124 - Dan Davison
 125 - Carsten Dominik
 126 - Miguel A. Figueroa-Villanueva
 127 - Mikael Fornius
 128 - Eric S. Fraga
 129 - Daniel M German
 130 - Bastien Guerry
 131 - Bernt Hansen
 132 - Tomas Hlavaty
 133 - Tassilo Horn
 134 - Phil Jackson
 135 - Peter Jones
 136 - Tokuya Kameshima
 137 - Richard Klinda
 138 - Christopher League
 139 - Ross Patterson
 140 - Jason Riedy
 141 - Philip Rooke
 142 - Sebastian Rose
 143 - Eric Schulte
 144 - Charles Sebold
 145 - James TD Smith
 146 - Andy Steward
 147 - Christopher Suckling
 148 - David O'Toole
 149 - John Wiegley
 150 - Piotr Zielinski
 151
 152 #+BEGIN: timestamp :string "Last update: " :format "%Y-%m-%d @ %H:%M"
 153 Last update: 2008-02-10 @ 16:12
 154 #+END: