Add No Wayman to the list of contributors
[worg.git] / org-contribute.org
blob4e477553398e7f6d303f18534361fc6e975bc5ca
1 #+TITLE:      How to contribute to Org?
2 #+AUTHOR:     Worg people
3 #+EMAIL:      mdl AT imapmail DOT org
4 #+OPTIONS:    H:3 num:nil toc:t \n:nil ::t |:t ^:nil -:t f:t *:t tex:t d:(HIDE) tags:not-in-toc
5 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
6 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
7 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
8 #+LANGUAGE:   en
9 #+PRIORITIES: A C B
10 #+CATEGORY:   worg
12 # This file is the default header for new Org files in Worg.  Feel free
13 # to tailor it to your needs.
15 [[file:index.org][{Back to Worg's index}]]
17 * Types of contributions
18 :PROPERTIES:
19 :CUSTOM_ID: types-of-contributions
20 :END:
22 Every contribution to Org is very welcome.  Here is a list of areas
23 where your contribution will be useful:
25 - bug reports :: Before sending a bug report, make sure you have read
26   this section of Org's manual: [[https://orgmode.org/org.html#Feedback][Feedback]] You can also read this great
27   text: "[[http://www.chiark.greenend.org.uk/~sgtatham/bugs.html][How to Send Bug Reports Effectively]]"
29 - patches :: You can submit patches to the mailing list.  See the [[For Org contributors: preferred way of submitting
30   patches][Preferred way of submitting patches]] section for details.  You can run
31   =make test= to check that your patch does not introduce new bugs.
33   If your patch is against a file that is part of Emacs, then your
34   total contribution (all patches you submit) should change /less than
35   15 lines/ (See the [[http://git.savannah.gnu.org/cgit/emacs.git/tree/CONTRIBUTE][CONTRIBUTE file in GNU Emacs]].)  If you contribute
36   more, you have to assign the copyright of your contribution to the
37   Free Software Foundation (see below).
39 - material to the Worg website :: This website is made of Org files
40   that you can contribute to.  Learn what Worg is [[file:worg-about.org][about]] and how to
41   contribute to it [[file:worg-git.org][through git]].
43 - feature requests :: Org is already mature, but new ideas keep
44   popping up.  If you want to request a feature, first dig into the
45   mailing list to find similar proposals.  If you cannot find any,
46   subscribe to [[file:org-mailing-list.org][the mailing list]], read it for a while, then make your
47   proposal.  Formulate it as detailed as possible, if possible with
48   examples.
50 - Org add-ons :: there are many Org add-ons.
51   - The best way is to submit your code to [[file:org-mailing-list.org][the mailing list]] to discuss
52     it with people.
53   - If it is useful, you might consider contributing it to the
54     =lisp/contrib/= directory in the git repository.  It will be
55     reviewed, and if it passes, it will be included.  The
56     =lisp/contrib/= directory is somehow relaxed: it is not distributed
57     with Emacs, and does not require a formal copyright assignment.
58   - If you decide to sign the [[*Copyright issues when contributing to Emacs Org mode][assignment contract with the FSF]], we
59     might include your contribution in the distribution, and then in
60     GNU Emacs.
62 * Copyright issues when contributing to Emacs Org mode
63 :PROPERTIES:
64 :CUSTOM_ID: copyright-issues
65 :END:
67 Org is made of many files.  Most of them are also distributed as part
68 of GNU Emacs.  These files are called the /Org core/, and they are all
69 copyrighted by the [[http://www.fsf.org][Free Software Foundation, Inc]].
71 If you consider contributing to these files, your first need to grant
72 the right to include your works in GNU Emacs to the FSF.  For this you
73 need to complete [[https://orgmode.org/request-assign-future.txt][this form]], and send it to [[mailto:assign@gnu.org][assign@gnu.org]].
75 The FSF will send you the assignment contract that both you and the
76 FSF will sign.  Please let the Org mode maintainer know when this
77 process is complete.
79 If you want to learn more about /why/ copyright assignments are
80 collected, read this: [[http://www.gnu.org/licenses/why-assign.html][Why the FSF gets copyright assignments from
81 contributors?]]
83 By submitting patches to =emacs-orgmode@gnu.org= or by pushing changes
84 to Org's core files, you are placing these changes under the same
85 licensing terms as those under which GNU Emacs is published.
87 #+begin_example
88 ;; GNU Emacs is free software: you can redistribute it and/or modify
89 ;; it under the terms of the GNU General Public License as published by
90 ;; the Free Software Foundation, either version 3 of the License, or
91 ;; (at your option) any later version.
92 #+end_example
94 If at the time you submit or push these changes you do have active
95 copyright assignment papers with the FSF, for future changes to either
96 Org mode or to Emacs, this means that copyright to these changes is
97 automatically transferred to the FSF.
99 The Org mode repository is seen as upstream repository for Emacs,
100 anything contained in it can potentially end up in Emacs.  If you do
101 not have signed papers with the FSF, only changes to files in the
102 =contrib/= part of the repository will be accepted, as well as very
103 minor changes (so-called /tiny changes/) to core files.  We will ask you
104 to sign FSF papers at the moment we attempt to move a =contrib/= file
105 into the Org core, or into Emacs.
107 * For Org developers
108   :PROPERTIES:
109   :CUSTOM_ID: devs
110   :END:
112 Org developers are those who have write access to the repository.
114 ** Git branches
116 Please read Worg's page on [[https://orgmode.org/worg/org-maintainance.html][Org maintainance]].
118 ** Pushing your first commit
120 1. Send [[mailto:bzgATgnuDOTorg][Bastien]] the username you want for https://code.orgmode.org
121 2. Add your public key to the account
122 3. Clone =org-mode.git=: =~$ git clone git@code.orgmode.org:bzg/org-mode.git=
123 4. Commit your changes against the code and the documentation.
124 5. Run =make test=
125 6. If the tests pass, push your changes.
127 If you are undertaking big changes, please create a dedicated branch
128 and make sure you have a clean commit history before merging it into
129 the maint or master branch.
131 * For Org contributors: preferred way of submitting patches
132 :PROPERTIES:
133 :CUSTOM_ID: patches
134 :END:
136 ** Coding conventions
138 Org is part of Emacs, so any contribution should follow the [[http://www.gnu.org/software/emacs/manual/html_node/elisp/Coding-Conventions.html][GNU Emacs
139 Lisp coding conventions]] described in Emacs manual.
141 ** Sending patch with git
143 Please use Git to make patches and send them via email -- this is
144 perfectly fine for major and minor changes.
146 When sending a patch (either using =git diff= or =git format-patch=)
147 please *always add a properly formatted Emacs ChangeLog entry*.  See
148 [[#commit-messages][this section]] for details on how to create such a ChangeLog.
150 ** Sending commits
152 For every patch you send, we suggest to use =git format-patch=.
154 This is easy for small patches and more consequent ones.  Sometimes,
155 you might even want to work in several steps and send each commit
156 separately.  Here is the suggested workflow:
158 #+begin_quote
159 :   ~$ git pull                 # make sure your repo is up to date
160 :   ~$ git branch my-changes    # create a new branch from master
161 :   ~$ git checkout my-changes  # switch to this new branch
163   ... make some changes (1) ...
165 :   ~$ git commit -a -m "This is change (1)"  # Commit your change
167   ... make another change (2) ...
169 :   ~$ git commit -a -m "This is change (2)"  # Commit your change
170 :   ~$ git format-patch master                # Creates two patches
172   ... Then two patches for your two commits are ready to be sent to
173   the list.
174 #+end_quote
176 To finally send the patches, you can either add them as attachments to
177 your email, or use [[https://git-scm.com/docs/git-send-email][git send-email]], if it's properly configured.
179 Write useful commit messages: please provide 1) a reason for it in
180 your email and 2) a ChangeLog entry in the commit message (see [[#commit-messages][this
181 section]] on how to format a ChangeLog entry.)
183 ** Sending quick fixes for testing purpose
185 If you want to send a quick fix that needs to be further tested by
186 other people (before you submit a real patch), here is how you can do:
188 #+begin_quote
189   This command will make a patch between the staging area (in your
190   computer), and the file you modified:
192   : git diff -p org-whatever.el > org-whatever.el.diff
194   If you already committed your changes to your index (staging area), then
195   you should compare against a particular branch (in this example,
196   origin/master):
198   : git diff -p origin/master org-whatever.el > org-whatever.el.diff
200   You email the output to the mailing list, adding =[PATCH]= to the
201   subject, and description of what you fixed or changed.
202 #+end_quote
204 Note that small patches sent like this still need to have a ChangeLog
205 entry to be applied.  If your patch looks good to you, it's always
206 better to send a patch through =git format-patch=.
208 ** Sharing changes from a public branch
210 When discussing important changes, it is sometimes not so useful to
211 send long and/or numerous patches.
213 In this case, you can maintain your changes on a public branch of a
214 public clone of Org and send a link to the diff between your changes
215 and the latest Org commit that sits in your clone.
217 If the discussion settles and your change is accepted, you can now
218 send it as (a list of) patch(es) to the latest Org version.
220 * Commit messages and ChangeLog entries
221 :PROPERTIES:
222 :CUSTOM_ID: commit-messages
223 :END:
225 We have decided to no longer keep a ChangeLog file to record changes
226 to individual functions.
228 A commit message should be constructed in the following way:
230 - Line 1 of the commit message should always be a short description of
231   the overall change.  Line 1 does /not/ get a dot at the end and does
232   not start with a star.  Generally, it starts with the filename that
233   has been changed, followed by a colon.
235 - Line 2 is an empty line.
237 - In line 3, the ChangeLog entry should start.  A ChangeLog entry
238   looks like [[https://orgmode.org/cgit.cgi/org-mode.git/commit/?id%3Dd49957ef021e256f19092c907d127390d39ec1ed][this]]:
240   : * org-timer.el (org-timer-cancel-timer, org-timer-stop): Enhance
241   : message.
242   : (org-timer-set-timer): Use the number of minutes in the Effort
243   : property as the default timer value. Three prefix arguments will
244   : ignore the Effort value property.
246 - After the changelog, another empty line should come before any
247   additional information that the committer wishes to provide in order
248   to explain the patch.
250 - If the change is a minor change made by a committer without
251   copyright assignment to the FSF, the commit message should also
252   contain the cookie =TINYCHANGE= (anywhere in the message).  When we
253   later produce the ChangeLog file for Emacs, the change will be
254   marked appropriately.
256 - Variables and functions names are quoted like `this' (backquote and
257   single quote).
259 - Sentences should be separated by two spaces.
261 - Sentences should start with an uppercase letter.
263 - Avoid the passive form: i.e., use "change" instead of "changed".
265 Here is an example for such a message:
267 #+begin_example
268   org-capture.el: Fix the case of using a template file
270   ,* lisp/org-capture.el (org-capture-set-plist): Make sure txt is a
271   string before calling `string-match'.
272   (org-capture-templates): Fix customization type.
274   ,* doc/org.texi (Capture): Document using a file for a template.
276   The problem here was that a wrong keyword was given in the
277   customization type.  This let to a string-match against a list value.
279   Modified from a patch proposal by Johan Friis.
281   TINYCHANGE
282 #+end_example
284 If you are using /magit.el/ in Emacs, the ChangeLog for such entries are
285 easily produced by pressing =C= in the diff listing.
287 Another option to produce the entries is to use `C-x 4 a' in the
288 changed function or in the diff listing.  This will create entries in
289 the ChangeLog file, and you can then cut and paste these to the commit
290 message and remove the indentation.
292 - Further reference: [[http://git.savannah.gnu.org/cgit/emacs.git/plain/CONTRIBUTE][Contribution guide from Emacs repo]]
294 * Copyrighted contributors to Org mode
295 :PROPERTIES:
296 :CUSTOM_ID: copyrighted-contributors
297 :END:
299 Here is the list of people who have contributed actual code to the Org
300 mode core.  Note that the manual contains a more extensive list with
301 acknowledgments, including contributed ideas!  The lists below are
302 mostly for house keeping, to help the maintainers keep track of
303 copyright issues.
305 ** Current contributors
306   :PROPERTIES:
307   :CUSTOM_ID: contributors_with_fsf_papers
308   :END:
310 Here is the list of people who signed the papers with the Free Software
311 Foundation and can now freely submit code to Org files that are included
312 within GNU Emacs:
314 - Aaron Ecay
315 - Aaron Jensen
316 - Abdó Roig-Maranges
317 - Achim Gratz
318 - Adam Elliott
319 - Adam Porter
320 - Adam Spiers
321 - Alan Schmitt
322 - Alex Branham
323 - Alexey Lebedeff
324 - Allen Li
325 - Andreas Burtzlaff
326 - Andreas Leha
327 - Andrew Hyatt
328 - Andrzej Lichnerowicz
329 - Andy Steward
330 - Anthony John Day
331 - Anthony Lander
332 - Arni Magnusson
333 - Arun Isaac
334 - Baoqiu Cui
335 - Barry Leonard Gidden
336 - Bastien Guerry
337 - Benjamin Andresen
338 - Bernd Grobauer
339 - Bernt Hansen
340 - Bjarte Johansen
341 - Brian James Gough
342 - Brice Waegenire
343 - Carlos Pita
344 - Carsten Dominik
345 - Charles Berry
346 - Charles Sebold
347 - Christian Egli
348 - Christian Garbs
349 - Christian Moe
350 - Christopher League
351 - Christopher Miles Gray
352 - Christopher Schmidt
353 - Christopher Suckling
354 - Clément Pit--Claudel
355 - Dan Davison
356 - Daniel M German
357 - Daniel M.\nbsp{}Hackney
358 - David Arroyo Menéndez
359 - David Maus
360 - David O'Toole
361 - Dieter Schoen
362 - Dima Kogan
363 - Dmitry Antipov
364 - Don March
365 - Emmanuel Charpentier
366 - Eric Abrahamsen
367 - Eric Schulte
368 - Eric S.\nbsp{}Fraga
369 - Erik Hetzner
370 - Erik Iverson
371 - Ethan Ligon
372 - Feng Shu
373 - Florian Lindner
374 - Francesco Pizzolante
375 - Frederick Giasson
376 - Gary Oberbrunner
377 - George Kettleborough
378 - Georg Lehner
379 - Giovanni Ridolfi
380 - Greg Minshall
381 - Grégoire Jadi (aka Daimrod)
382 - Gustav Wikström
383 - Henning Dietmar Weiss
384 - Henry Blevins
385 - Ian Barton
386 - Ian Dunn
387 - Ian Kelling
388 - Ilya Shlyakhter
389 - Ingo Lohmar
390 - Ippei Furuhashi
391 - Jack Kamm
392 - Jake Romer
393 - James TD Smith
394 - Jan Böcker
395 - Jan Malakhovski
396 - Jarmo Hurri
397 - Jason Riedy
398 - Jay Kamat
399 - Jay Kerns
400 - Jeffrey Ryan Horn
401 - Jens Lechtenboerg
402 - Joe Corneli
403 - Joel Boehland
404 - John Kitchin
405 - John Wiegley
406 - Jonas Bernoulli
407 - Jonathan Leech-Pepin
408 - Jon Snader
409 - José L.\nbsp{}Doménech
410 - Juan Pechiar
411 - Julian Gehring
412 - Julien Barnier
413 - Julien Danjou
414 - Justin Gordon
415 - Justus Piater
416 - Karl Fogel
417 - Kaushal Modi
418 - Kevin Brubeck Unhammer
419 - Kevin Foley
420 - Kévin Le Gouguec
421 - Konstantin Antipin
422 - Kyle Meyer
423 - Lambda Coder
424 - Lawrence Mitchell
425 - Lele Gaifax
426 - Lennart Borgman
427 - Leonard Avery Randall
428 - Le Wang
429 - Luis Anaya
430 - Lukasz Stelmach
431 - Madan Ramakrishnan
432 - Magnus Henoch
433 - Manuel Giraud
434 - Marcin Borkowski
435 - Marco Wahl
436 - Mark A.\nbsp{}Hershberger
437 - Martin Pohlack
438 - Martyn Jago
439 - Matt Lundin
440 - Max Mikhanosha
441 - Michael Albinus
442 - Michael Brand
443 - Michael Gauland
444 - Michael Sperber
445 - Miguel A.\nbsp{}Figueroa-Villanueva
446 - Mikael Fornius
447 - Moritz Ulrich
448 - Nathaniel Flath
449 - Nathan Neff
450 - Neil Jerram
451 - Nicholas Dokos
452 - Nicolas Berthier
453 - Nicolas Dudebout
454 - Nicolas Goaziou
455 - Nicolas Richard
456 - Niels Giessen
457 - Nikolai Weibull
458 - Noorul Islam K M
459 - No Wayman
460 - Oleh Krehel
461 - Paul Sexton
462 - Pedro Alexandre Marcelino Costa da Silva
463 - Peter Jones
464 - Phil Hudson
465 - Philip Rooke
466 - Phil Jackson
467 - Pierre Téchoueyres
468 - Pieter Praet
469 - Piotr Zielinski
470 - Puneeth Chaganti
471 - Rafael Laboissière
472 - Rainer M Krug
473 - Rasmus Pank Roulund
474 - Richard Kim
475 - Richard Klinda
476 - Richard Riley
477 - Rick Frankel
478 - Robert Michael Irelan
479 - Roland Coeurjoly
480 - Rüdiger Sonderfeld
481 - Russell Adams
482 - Ryo Takaishi
483 - Sacha Chua
484 - Samuel Loury
485 - Sebastian Miele
486 - Sebastian Reuße
487 - Sebastian Rose
488 - Sebastien Vauban
489 - Sergey Litvinov
490 - Seweryn Kokot
491 - Simon Michael
492 - Siraphob Phipathananunth
493 - stardiviner
494 - Stefan Kangas
495 - Stephen Eglen
496 - Steven Rémot
497 - Suvayu Ali
498 - Takaaki Ishikawa
499 - Tassilo Horn
500 - TEC
501 - T.F. Torrey
502 - Thibault Marin
503 - Thierry Banel
504 - Thomas Baumann
505 - Thomas Fitzsimmons
506 - Thomas Holst
507 - Thomas S.\nbsp{}Dye
508 - Thorsten Jolitz
509 - Tim Burt
510 - Tim Landscheidt
511 - Titus von der Malsburg
512 - Toby Cubitt
513 - Tokuya Kameshima
514 - Tomas Hlavaty
515 - Tom Breton
516 - Tom Gillespie
517 - Tony Day
518 - Toon Claes
519 - Trevor Murphy
520 - Ulf Stegemann
521 - Vitalie Spinu
522 - Vladimir Panteleev
523 - Yann Hodique
524 - Yasushi Shoji
525 - Yoshinari Nomura
526 - Yuri D.\nbsp{}Lensky
527 - Zhang Weize
528 - Zhuo Qingliang (Killy Draw)
530 ** Processing
532 These people have been asked to sign the papers, and they are
533 currently considering it or a request is being processed by the FSF.
535 - Felipe Lema [2020-02-25 mar.]
536 - Terje Larsen [2020-02-17 lun.]
537 - Brian Carlson [2016-05-24 Tue]
538 - Mats Kindahl (as of 2013-04-06) for [[http://mid.gmane.org/513BAB7D.1000603@oracle.com][this patch]]
539 - Bill Wishon [?]
541 ** Tiny Changes
543 These people have submitted tiny change patches that made it into Org
544 without FSF papers.  When they submit more, we need to get papers
545 eventually.  The limit is a cumulative change of 20 non-repetitive
546 change lines.  Details are given in [[http://www.gnu.org/prep/maintain/maintain.html#Legally-Significant ][this document]].
548 - Aaron L.\nbsp{}Zeng
549 - Abhishek Chandratre
550 - Adam Aviv
551 - akater
552 - Aliaksey Artamonau
553 - Aman Yang
554 - Anders Johansson
555 - Andrew Burgess
556 - Andrew Eggenberger
557 - Andrii Kolomoiets
558 - Andy Lutomirski
559 - Anthony Cowley
560 - Anton Latukha
561 - Arne Babenhauserheide
562 - Arun Persaud
563 - Augustin Fabre
564 - Aurélien Aptel
565 - Austin Walker
566 - Axel Kielhorn
567 - Brad Knotwell
568 - Brian Powell
569 - Cheong Yiu Fung
570 - Christian Hopps
571 - Christian Schwarzgruber
572 - Chunyang Xu
573 - Claudiu Tănăselia
574 - Craig Tanis
575 - Dan Drake
576 - Daniel Peres Gomez
577 - Derek Feichtinger
578 - Dima Gerasimov
579 - Dominik Schrempf
580 - Doro Rose
581 - Eduardo Bellani
582 - Eric Danan
583 - Eric Timmons
584 - Federico Beffa
585 - Feng Zhou
586 - Fernando Varesi
587 - Florian Beck
588 - Francesco Montanari
589 - Galen Menzel
590 - Georgiy Tugai
591 - Gong Qijian
592 - Gregor Zattler
593 - Greg Tucker-Kellogg
594 - Hiroshi Saito
595 - Ivan Vilata i Balaguer
596 - Jack Henahan
597 - Jacob Gerlach
598 - Jacob Matthews
599 - Jakob Lombacher
600 - Jamie Forth
601 - Jan Seeger
602 - Jason Dunsmore
603 - Jason Furtney
604 - Jeff Larson
605 - Joaquín Aguirrezabalaga
606 - Joe Hirn
607 - John Foerch
608 - John Lee
609 - Jonas Hörsch
610 - Jon Miller
611 - Joost Diepenmaat
612 - Jose Robins
613 - Kodi Arfer
614 - Konstantin Kliakhandler
615 - Kovacsics Robert
616 - Leo Vivier
617 - Leslie Harlley Watter
618 - Leslie Watter
619 - Lixin Chin
620 - Luke Amdor
621 - Mak Kolybabi
622 - Marc Ihm
623 - Mario Frasca
624 - Mario Martelli
625 - Marshall Flax
626 - Martin Šlouf
627 - Martin Vuk
628 - Matthew Gidden
629 - Matthew MacLean
630 - Matt Huszagh
631 - Matt Price
632 - Max Mouratov
633 - Michaël Cadilhac
634 - Michael O'Connor
635 - Michael Strey
636 - Michael Welle
637 - Michael Weylandt
638 - Mike Ivanov
639 - Mike McLean
640 - Miro Bezjak
641 - Moritz Kiefer
642 - Muchenxuan Tong
643 - Myles English
644 - Myq Larson
645 - Nathaniel Nicandro
646 - Nicholas Vollmer
647 - Nick Gunn
648 - Nicolò Balzarotti
649 - Peter Feigl
650 - Peter Moresi
651 - Philip (Pip Cet)
652 - Piet van Oostrum
653 - Renato Ferreira
654 - Richard Hansen
655 - Richard Lawrence
656 - Richard Y.\nbsp{}Kim (Kim)
657 - Robert Hambrock
658 - Roberto Huelga
659 - Robert P.\nbsp{}Goldman
660 - Roger Welsh
661 - Ruben Maher
662 - Sami Airaksinen
663 - Saulius Menkevičius
664 - Sebastien Le Maguer
665 - Sergey Gordienko
666 - Seth Robertson
667 - Sigmund Tzeng
668 - Stacey Marshall
669 - Stanley Jaddoe
670 - Stefano Rodighiero
671 - Stefan-W.\nbsp{}Hahn
672 - Stig Brautaset
673 - Sylvain Chouleur
674 - Tadashi Hirata
675 - Teika Kazura
676 - Terje Larsen
677 - Thierry Pellé
678 - Thomas Alexander Gerds
679 - Thomas Plass
680 - Thomas Rikl
681 - Tim Visher
682 - Tobias Schlemmer
683 - Tom Hinton
684 - Vicente Vera Parra
685 - Viktor Rosenfeld
686 - Vladimir Lomov
687 - Wojciech Gac
688 - Xavier Martinez-Hidalgo
689 - Xi Shen
690 - Yann Esposito
691 - York Zhao
692 - Yue Zhu
693 - Zane D.\nbsp{}Purvis
694 - Иван Трусков
696 (This list may be incomplete - please help completing it.)
698 ** No FSF assignment
700 These people cannot or prefer to not sign the FSF copyright papers,
701 and we can only accept patches that do not change the core files (the
702 ones that are also in Emacs).
704 Luckily, this list is still empty.
706 #+BEGIN: timestamp :string "Last update: " :format "%Y-%m-%d @ %H:%M"
708 #+END: