Mercurial > emacs

comparison CONTRIBUTE @ 71660:475dcca89ec9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Slight formatting changes and typo fixes. Add description of NEWS markings.
author Eli Zaretskii <eliz@gnu.org>
date Fri, 07 Jul 2006 11:20:20 +0000
parents 2abae690629b
children a99d8ae1c5d9
comparison
equal deleted inserted replaced
71659:0a57a8cfd0fa 71660:475dcca89ec9
32 before we can use it. 32 before we can use it.
33 33
34 Emacs has certain additional style and coding conventions. 34 Emacs has certain additional style and coding conventions.
35 35
36 Ref: http://www.gnu.org/prep/standards_toc.html 36 Ref: http://www.gnu.org/prep/standards_toc.html
37 Ref: Standards Info Manual 37 Ref: GNU Coding Standards Info Manual
38 38
39 39
40 o Copyright Assignment 40 o Copyright Assignment
41 41
42 We can accept small changes without legal papers, and for 42 We can accept small changes without legal papers, and for
43 medium-size changes a copyright disclaimer is ok too. Toa 43 medium-size changes a copyright disclaimer is ok too. To
44 accept substantial contributions from you, we need a copyright 44 accept substantial contributions from you, we need a copyright
45 assignment form filled out and filed with the FSF. 45 assignment form filled out and filed with the FSF.
46 46
47 Contact us at emacs-devel@gnu.org to obtain the relevant 47 Contact us at emacs-devel@gnu.org to obtain the relevant
48 forms. 48 forms.
50 50
51 o Getting the Source Code 51 o Getting the Source Code
52 52
53 The latest version of Emacs can be downloaded using CVS or 53 The latest version of Emacs can be downloaded using CVS or
54 Arch from the Savannah web site. It is important to write 54 Arch from the Savannah web site. It is important to write
55 your patch based this version; if you start from an older 55 your patch based on this version; if you start from an older
56 version, your patch may be outdated when you write it. 56 version, your patch may be outdated when you write it, and
57 maintainers will have hard time applying it.
57 58
58 After you have downloaded the source, you should read the file 59 After you have downloaded the CVS source, you should read the
59 INSTALL.CVS for further instructions. 60 file INSTALL.CVS for build instructions (they differ to some
61 extent from a normal build).
60 62
61 Ref: http://savannah.gnu.org/projects/emacs 63 Ref: http://savannah.gnu.org/projects/emacs
62 64
63 65
64 o Submitting Patches 66 o Submitting Patches
65 67
66 Every patch must have several pieces of information before we 68 Every patch must have several pieces of information before we
67 can properly evaluate it. 69 can properly evaluate it.
68 70
69 For bug fixes, a description of the bug and how your patch fixes 71 * For bug fixes, a description of the bug and how your patch
70 this bug. 72 fixes this bug.
71 73
72 For new features, a description of the feature and your 74 * For new features, a description of the feature and your
73 implementation. 75 implementation.
74 76
75 A ChangeLog entry as plaintext (separate from the patch); see 77 * A ChangeLog entry as plaintext (separate from the patch);
76 the various ChangeLog files for format and content. Note that, 78 see the various ChangeLog files for format and content. Note
77 unlike some other projects, we do require ChangeLogs also for 79 that, unlike some other projects, we do require ChangeLogs
78 documentation i.e. texinfo files. 80 also for documentation, i.e. Texinfo files.
79 81
80 Ref: Change Log Concepts node of the Standards Info Manual 82 Ref: "Change Log Concepts" node of the GNU Coding Standards
83 Info Manual, for how to write good log entries.
81 84
82 The patch itself. If you are accessing the CVS repository use 85 * The patch itself. If you are accessing the CVS repository
83 "cvs update; cvs diff -cp"; else, use "diff -cp OLD NEW". If 86 use "cvs update; cvs diff -cp"; else, use "diff -cp OLD NEW".
84 your version of diff does not support these options, then get 87 If your version of diff does not support these options, then
85 the latest version of GNU diff. 88 get the latest version of GNU Diff.
86 89
87 We accept patches as plain text (preferred for the compilers 90 * We accept the patches as plain text (preferred for the
88 themselves), MIME attachments (preferred for the web pages), or 91 compilers themselves), MIME attachments (preferred for the
89 as uuencoded gzipped text. 92 web pages), or as uuencoded gzipped text.
90 93
91 When you have all these pieces, bundle them up in a mail message 94 When you have all these pieces, bundle them up in a mail message
92 and send it to emacs-pretest-bug@gnu.org or emacs-devel@gnu.org. 95 and send it to emacs-pretest-bug@gnu.org or emacs-devel@gnu.org.
93 All subsequent discussion should also be sent to the mailing 96 All subsequent discussion should also be sent to the mailing
94 list. 97 list.
112 115
113 Think carefully about whether your change requires updating the 116 Think carefully about whether your change requires updating the
114 documentation. If it does, you can either do this yourself or 117 documentation. If it does, you can either do this yourself or
115 add an item to the NEWS file. 118 add an item to the NEWS file.
116 119
117 The best way to understand Emacs Internals is to read the code 120 If you document your change in NEWS, please mark the NEWS
118 but the nodes "Tips" and "GNU Emacs Internals" in the Appendix 121 entry with the documentation status of the change: if you
122 submit the changes for the manuals, mark it with "+++"; if it
123 doesn't need to be documented, mark it with "---"; if it needs
124 to be documented, but you didn't submit documentation changes,
125 leave the NEWS entry unmarked. (These marks are checked by
126 the Emacs maintainers to make sure every change was reflected
127 in the manuals.)
128
129 The best way to understand Emacs Internals is to read the code,
130 but the nodes "Tips" and "GNU Emacs Internals" in the Appendix
119 of the Emacs Lisp Reference Manual may also help. 131 of the Emacs Lisp Reference Manual may also help.
120 132
121 The file DEBUG describes how to debug Emacs bugs. 133 The file etc/DEBUG describes how to debug Emacs bugs.
122 134
123 Avoid using `defadvice' or `eval-after-load' for Lisp 135 Avoid using `defadvice' or `eval-after-load' for Lisp
124 code to be included in Emacs. 136 code to be included in Emacs.