etc/CONTRIBUTE

   1 Copyright (C) 2006-2013 Free Software Foundation, Inc.
   2 See end for license conditions.
   3
   4
   5                         Contributing to Emacs
   6
   7 Emacs is a collaborative project and we encourage contributions from
   8 anyone and everyone.  If you want to contribute in the way that will
   9 help us most, we recommend (1) fixing reported bugs and (2)
  10 implementing the feature ideas in etc/TODO.  However, if you think of
  11 new features to add, please suggest them too -- we might like your
  12 idea.  Porting to new platforms is also useful, when there is a new
  13 platform, but that is not common nowadays.
  14
  15 For documentation on how to develop Emacs changes, refer to the Emacs
  16 Manual and the Emacs Lisp Reference Manual (both included in the Emacs
  17 distribution).  The web pages in http://www.gnu.org/software/emacs
  18 contain additional information.
  19
  20 You may also want to submit your change so that can be considered for
  21 inclusion in a future version of Emacs (see below).
  22
  23 If you don't feel up to hacking Emacs, there are many other ways to
  24 help.  You can answer questions on the mailing lists, write
  25 documentation, find and report bugs, check if existing bug reports
  26 are fixed in newer versions of Emacs, contribute to the Emacs web
  27 pages, or develop a package that works with Emacs.
  28
  29 Here are some style and legal conventions for contributors to Emacs:
  30
  31
  32 * Coding Standards
  33
  34 Contributed code should follow the GNU Coding Standards.
  35
  36 If it doesn't, we'll need to find someone to fix the code before we
  37 can use it.
  38
  39 Emacs has certain additional style and coding conventions.
  40
  41 Ref: http://www.gnu.org/prep/standards/
  42 Ref: GNU Coding Standards Info Manual
  43 Ref: The "Tips" Appendix in the Emacs Lisp Reference.
  44
  45
  46 * Copyright Assignment
  47
  48 The FSF (Free Software Foundation) is the copyright holder for GNU Emacs.
  49 The FSF is a nonprofit with a worldwide mission to promote computer
  50 user freedom and to defend the rights of all free software users.
  51 For general information, see the website http://www.fsf.org/ .
  52
  53 Generally speaking, for non-trivial contributions to GNU Emacs we
  54 require that the copyright be assigned to the FSF.  For the reasons
  55 behind this, see: http://www.gnu.org/licenses/why-assign.html .
  56
  57 Copyright assignment is a simple process.  If you live in the US, you
  58 can do it entirely electronically.  We can help you get started, and
  59 answer any questions you may have (or point you to the people with the
  60 answers), at the emacs-devel@gnu.org mailing list.
  61
  62 A copyright disclaimer is also a possibility, but we prefer an assignment.
  63 Note that the disclaimer, like an assignment, involves you sending
  64 signed paperwork to the FSF (simply saying "this is in the public domain"
  65 is not enough).  Also, a disclaimer cannot be applied to future work, it
  66 has to be repeated each time you want to send something new.
  67
  68 We can accept small changes (roughly, fewer than 15 lines) without
  69 an assignment.  This is a cumulative limit (e.g. three separate 5 line
  70 patches) over all your contributions.
  71
  72 * Getting the Source Code
  73
  74 The latest version of Emacs can be downloaded using Bazaar from the
  75 Savannah web site.  It is important to write your patch based on the
  76 latest version.  If you start from an older version, your patch may be
  77 outdated (so that maintainers will have a hard time applying it), or
  78 changes in Emacs may have made your patch unnecessary.
  79
  80 After you have downloaded the Bazaar source, you should read the file
  81 INSTALL.BZR for build instructions (they differ to some extent from a
  82 normal build).
  83
  84 Ref: http://savannah.gnu.org/projects/emacs
  85
  86
  87 * Submitting Patches
  88
  89 Every patch must have several pieces of information before we
  90 can properly evaluate it.
  91
  92 When you have all these pieces, bundle them up in a mail message and
  93 send it to the developers.  Sending it to bug-gnu-emacs@gnu.org
  94 (which is the bug/feature list) is recommended, because that list
  95 is coupled to a tracking system that makes it easier to locate patches.
  96 If your patch is not complete and you think it needs more discussion,
  97 you might want to send it to emacs-devel@gnu.org instead.  If you
  98 revise your patch, send it as a followup to the initial topic.
  99
 100 ** Description
 101
 102 For bug fixes, a description of the bug and how your patch fixes it.
 103
 104 For new features, a description of the feature and your implementation.
 105
 106 ** ChangeLog
 107
 108 A ChangeLog entry as plaintext (separate from the patch).
 109
 110 See the existing ChangeLog files for format and content.  Note that,
 111 unlike some other projects, we do require ChangeLogs also for
 112 documentation, i.e. Texinfo files.
 113
 114 Ref: "Change Log Concepts" node of the GNU Coding Standards Info
 115 Manual, for how to write good log entries.
 116
 117 ** The patch itself.
 118
 119 If you are accessing the Bazaar repository, make sure your copy is
 120 up-to-date (e.g. with `bzr pull'), then use
 121         bzr diff --no-aliases --diff-options=-cp
 122 Else, use
 123         diff -cp OLD NEW
 124
 125 ** Mail format.
 126
 127 We prefer to get the patches as plain text, either inline (be careful
 128 your mail client does not change line breaks) or as MIME attachments.
 129
 130 ** Please reread your patch before submitting it.
 131
 132 ** Do not mix changes.
 133
 134 If you send several unrelated changes together, we will ask you to
 135 separate them so we can consider each of the changes by itself.
 136
 137 ** Do not make formatting changes.
 138
 139 Making cosmetic formatting changes (indentation, etc) makes it harder
 140 to see what you have really changed.
 141
 142
 143 * Coding style and conventions.
 144
 145 ** Mandatory reading:
 146
 147 The "Tips and Conventions" Appendix of the Emacs Lisp Reference.
 148
 149 ** Avoid using `defadvice' or `eval-after-load' for Lisp code to be
 150 included in Emacs.
 151
 152 ** Remove all trailing whitespace in all source and text files.
 153
 154 ** Use ?\s instead of ?  in Lisp code for a space character.
 155
 156
 157 * Supplemental information for Emacs Developers.
 158
 159 ** Write access to the Emacs repository.
 160
 161 Once you become a frequent contributor to Emacs, we can consider
 162 giving you write access to the Bazaar repository.
 163
 164
 165 ** Emacs Mailing lists.
 166
 167 Discussion about Emacs development takes place on emacs-devel@gnu.org.
 168
 169 Bug reports and fixes, feature requests and implementations should be
 170 sent to bug-gnu-emacs@gnu.org, the bug/feature list.  This is coupled
 171 to the tracker at http://debbugs.gnu.org .
 172
 173 You can subscribe to the mailing lists, or see the list archives,
 174 by following links from http://savannah.gnu.org/mail/?group=emacs .
 175
 176 ** Document your changes.
 177
 178 Any change that matters to end-users should have a NEWS entry.
 179
 180 Think about whether your change requires updating the documentation
 181 (both manuals and doc-strings).  If you know it does not, mark the NEWS
 182 entry with "---".  If you know that *all* the necessary documentation
 183 updates have been made, mark the entry with "+++". Otherwise do not mark it.
 184
 185 ** Understanding Emacs Internals.
 186
 187 The best way to understand Emacs Internals is to read the code,
 188 but the nodes "Tips" and "GNU Emacs Internals" in the Appendix
 189 of the Emacs Lisp Reference Manual may also help.
 190
 191 The file etc/DEBUG describes how to debug Emacs bugs.
 192
 193
 194 \f
 195 This file is part of GNU Emacs.
 196
 197 GNU Emacs is free software: you can redistribute it and/or modify
 198 it under the terms of the GNU General Public License as published by
 199 the Free Software Foundation, either version 3 of the License, or
 200 (at your option) any later version.
 201
 202 GNU Emacs is distributed in the hope that it will be useful,
 203 but WITHOUT ANY WARRANTY; without even the implied warranty of
 204 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 205 GNU General Public License for more details.
 206
 207 You should have received a copy of the GNU General Public License
 208 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 209 \f
 210 Local variables:
 211 mode: outline
 212 paragraph-separate: "[  \f]*$"
 213 end:
 214