Mercurial > emacs

comparison CONTRIBUTE @ 71608:e4b43205e213

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
*** empty log message ***
author Nick Roberts <nickrob@snap.net.nz>
date Tue, 04 Jul 2006 11:23:36 +0000
parents 801b0f932405
children fc0f241e3ff8
comparison
equal deleted inserted replaced
71607:8ea025e6387a 71608:e4b43205e213
8 available. In addition to the user guide and Lisp Reference Manual in 8 available. In addition to the user guide and Lisp Reference Manual in
9 the Emacs distribution, the Emacs web pages also contain much 9 the Emacs distribution, the Emacs web pages also contain much
10 information. 10 information.
11 11
12 You may also want to submit your change so that can be considered for 12 You may also want to submit your change so that can be considered for
13 conclusion in a future version of Emacs (see below). 13 inclusion in a future version of Emacs (see below).
14 14
15 If you don't feel up to hacking Emacs, there are still plenty of ways to 15 If you don't feel up to hacking Emacs, there are still plenty of ways to
16 help! You can answer questions on the mailing lists, write 16 help! You can answer questions on the mailing lists, write
17 documentation, find bugs, create a Emacs related website (contribute to 17 documentation, find bugs, create a Emacs related website (contribute to
18 the official Emacs web site), or create a Emacs related software 18 the official Emacs web site), or create a Emacs related software
21 work in progress. 21 work in progress.
22 22
23 Ref: http://www.gnu.org/software/emacs/ 23 Ref: http://www.gnu.org/software/emacs/
24 24
25 Finally, there are certain legal requirements and style issues which 25 Finally, there are certain legal requirements and style issues which
26 all contributors need to be aware of. 26 all contributors need to be aware of:
27
27 28
28 o Coding Standards 29 o Coding Standards
29 30
30 All contributions must conform to the GNU Coding Standard. 31 All contributions must conform to the GNU Coding Standard.
31 Submissions which do not conform to the standards will be 32 Submissions which do not conform to the standards will be
32 returned with a request to reformat the changes. 33 returned with a request to reformat the changes.
33 34
34 Emacs has certain additional coding requirements. 35 Emacs has certain additional coding requirements.
35 36
36 Ref: http://www.gnu.org/prep/standards_toc.html 37 Ref: http://www.gnu.org/prep/standards_toc.html
38 Ref: Standards Info Manual
37 39
38 40
39 o Copyright Assignment 41 o Copyright Assignment
40 42
41 Before we can accept code contributions from you, we need a 43 Before we can accept code contributions from you, we need a
42 copyright assignment form filled out and filed with the FSF. 44 copyright assignment form filled out and filed with the FSF.
43 45
44 See some documentation by the FSF for details and contact us 46 Contact us via the Emacs mailing list to obtain the relevant
45 via the Emacs mailing list to obtain the relevant
46 forms. 47 forms.
47 48
48 Small changes can be accepted without a copyright assignment 49 Small changes can be accepted without a copyright assignment
49 form on file. 50 form on file.
50
51 Ref: http://www.gnu.org/prep/maintain.html#SEC6
52 51
53 52
54 o Getting the Source Code 53 o Getting the Source Code
55 54
56 The latest version of Emacs can be downloaded using CVS or Arch 55 The latest version of Emacs can be downloaded using CVS or Arch
57 from the Savannah web site. It is important that you submit 56 from the Savannah web site. It is important that you submit
58 your patch using this version, as any bug in a released version 57 your patch using this version, as any bug in a released version
59 of Emacs may already be fixed. It also makes it easier for 58 of Emacs may already be fixed. It also makes it easier for
60 others to test your patch, 59 others to test your patch.
61 60
62 Ref: http://savannah.gnu.org/projects/emacs 61 Ref: http://savannah.gnu.org/projects/emacs
63 62
64 63
65 o Submitting Patches 64 o Submitting Patches
74 implementation. 73 implementation.
75 74
76 A ChangeLog entry as plaintext (separate from the patch); see 75 A ChangeLog entry as plaintext (separate from the patch); see
77 the various ChangeLog files for format and content. Note that, 76 the various ChangeLog files for format and content. Note that,
78 unlike some other projects, we do require ChangeLogs also for 77 unlike some other projects, we do require ChangeLogs also for
79 documentation (i.e., .texi files). 78 documentation i.e. texinfo files.
80 79
81 The patch itself. If you are accessing the CVS repository use 80 Ref: Change Log Concepts node of the Standards Info Manual
82 "cvs update; cvs diff -cp"; else, use "diff -cp OLD NEW" or 81
83 "diff -up OLD NEW". If your version of diff does not support 82 The patch itself. If you are accessing the CVS repository use
84 these options, then get the latest version of GNU diff. 83 "cvs update; cvs diff -cp"; else, use "diff -cp OLD NEW". If
84 your version of diff does not support these options, then get
85 the latest version of GNU diff.
85 86
86 We accept patches as plain text (preferred for the compilers 87 We accept patches as plain text (preferred for the compilers
87 themselves), MIME attachments (preferred for the web pages), 88 themselves), MIME attachments (preferred for the web pages), or
88 or as uuencoded gzipped text. 89 as uuencoded gzipped text.
89 90
90 When you have all these pieces, bundle them up in a mail message 91 When you have all these pieces, bundle them up in a mail message
91 and send it to emacs-pretest-bug@gnu.org or emacs-devel@gnu.org. 92 and send it to emacs-pretest-bug@gnu.org or emacs-devel@gnu.org.
92 All patches and related discussion should be sent to the 93 All subsequent discussion should also be sent to the mailing
93 emacs-pretest-bug mailinglist. 94 list.
94 95
95 96
96 o Please read your patch before submitting it. 97 o Please read your patch before submitting it.
97 98
98 A patch containing several unrelated changes or 99 A patch containing several unrelated changes reformats will be
99 arbitrary reformats will be returned with a request 100 returned with a request to send them separately.
100 to re-formatting / split it.
101 101
102 102
103 o Supplemental information for Emacs Developers: 103 o Supplemental information for Emacs Developers:
104 104
105 If you wish to contribute to Emacs on a regular basis then 105 If you wish to contribute to Emacs on a regular basis then you
106 you may be given write access to the CVS repository. 106 may be given write access to the CVS repository.
107 107
108 Discussion about Emacs development takes place on 108 Discussion about Emacs development takes place on
109 emacs-devel@gnu.org. 109 emacs-devel@gnu.org.
110 110
111 Think carefully about whether your change requires updating the 111 Think carefully about whether your change requires updating the
112 documentation. If it does, you can either do this yourself or 112 documentation. If it does, you can either do this yourself or
113 add an item to the NEWS file. 113 add an item to the NEWS file.
114 114
115 The best way to understand Emacs Internals is to read the code 115 The best way to understand Emacs Internals is to read the code
116 but there is also a node "GNU Emacs Internals" in the Appendix 116 but the nodes "Tips" and "GNU Emacs Internals" in the Appendix
117 of the Emacs Lisp Reference Manual that may help. 117 of the Emacs Lisp Reference Manual may also help.
118 118
119 The file DEBUG describes how to debug Emacs. 119 The file DEBUG describes how to debug Emacs.
120 120
121 Avoid using `defadvice' or `eval-after-load' for lisp 121 Avoid using `defadvice' or `eval-after-load' for lisp
122 code to be included in Emacs. 122 code to be included in Emacs.