Mercurial > emacs
comparison CONTRIBUTE @ 90519:138ce2701550
Merge from emacs--devo--0
Patches applied:
* emacs--devo--0 (patch 320-342)
- Update from CVS
- Merge from gnus--rel--5.10
- lisp/play/cookie1.el (cookie): Work properly when there's only one entry
- Add note about "link" button-class to etc/TODO
* gnus--rel--5.10 (patch 108-112)
- Merge from emacs--devo--0
- Clean up merge mistakes
- Update from CVS
- Update from CVS: texi/gnus.texi (Summary Buffer Lines): Fix typo.
Revision: emacs@sv.gnu.org/emacs--unicode--0--patch-86
author | Miles Bader <miles@gnu.org> |
---|---|
date | Thu, 06 Jul 2006 08:59:39 +0000 |
parents | fc0f241e3ff8 |
children | 2abae690629b |
comparison
equal
deleted
inserted
replaced
90518:64c755511769 | 90519:138ce2701550 |
---|---|
1 | |
2 Contributing to Emacs | |
3 | |
4 Emacs is a collaborative project and we encourage contributions from | |
5 anyone and everyone. If you want to contribute in the way that will | |
6 help us most, we recommend (1) fixing reported bugs and (2) | |
7 implementing the feature ideas in etc/TODO. However, if you think of | |
8 new features to add, please suggest them too -- we might like your | |
9 idea. Porting to new platforms is also useful, when there is a new | |
10 platform, but that is not common nowadays. | |
11 | |
12 For documentation on how to develop Emacs changes, refer to the Emacs | |
13 Manual and the Emacs Lisp Reference Manual (both included in the Emacs | |
14 distribution). The web pages in http://www.gnu.org/software/emacs | |
15 contain additional information. | |
16 | |
17 You may also want to submit your change so that can be considered for | |
18 inclusion in a future version of Emacs (see below). | |
19 | |
20 If you don't feel up to hacking Emacs, there are many other ways to | |
21 help. You can answer questions on the mailing lists, write | |
22 documentation, find and report bugs, contribute to the Emacs web | |
23 pages, or develop a package that works with Emacs. | |
24 | |
25 Here are some style and legal conventions for contributors to Emacs: | |
26 | |
27 | |
28 o Coding Standards | |
29 | |
30 Contributed code should follow the GNU Coding Standard. | |
31 If it doesn't, we'll need to find someone to fix the code | |
32 before we can use it. | |
33 | |
34 Emacs has certain additional style and coding conventions. | |
35 | |
36 Ref: http://www.gnu.org/prep/standards_toc.html | |
37 Ref: Standards Info Manual | |
38 | |
39 | |
40 o Copyright Assignment | |
41 | |
42 We can accept small changes without legal papers, and for | |
43 medium-size changes a copyright disclaimer is ok too. Toa | |
44 accept substantial contributions from you, we need a copyright | |
45 assignment form filled out and filed with the FSF. | |
46 | |
47 Contact us at emacs-devel@gnu.org to obtain the relevant | |
48 forms. | |
49 | |
50 | |
51 o Getting the Source Code | |
52 | |
53 The latest version of Emacs can be downloaded using CVS or | |
54 Arch from the Savannah web site. It is important to write | |
55 your patch based this version; if you start from an older | |
56 version, your patch may be outdated when you write it. | |
57 | |
58 Ref: http://savannah.gnu.org/projects/emacs | |
59 | |
60 | |
61 o Submitting Patches | |
62 | |
63 Every patch must have several pieces of information before we | |
64 can properly evaluate it. | |
65 | |
66 For bug fixes, a description of the bug and how your patch fixes | |
67 this bug. | |
68 | |
69 For new features, a description of the feature and your | |
70 implementation. | |
71 | |
72 A ChangeLog entry as plaintext (separate from the patch); see | |
73 the various ChangeLog files for format and content. Note that, | |
74 unlike some other projects, we do require ChangeLogs also for | |
75 documentation i.e. texinfo files. | |
76 | |
77 Ref: Change Log Concepts node of the Standards Info Manual | |
78 | |
79 The patch itself. If you are accessing the CVS repository use | |
80 "cvs update; cvs diff -cp"; else, use "diff -cp OLD NEW". If | |
81 your version of diff does not support these options, then get | |
82 the latest version of GNU diff. | |
83 | |
84 We accept patches as plain text (preferred for the compilers | |
85 themselves), MIME attachments (preferred for the web pages), or | |
86 as uuencoded gzipped text. | |
87 | |
88 When you have all these pieces, bundle them up in a mail message | |
89 and send it to emacs-pretest-bug@gnu.org or emacs-devel@gnu.org. | |
90 All subsequent discussion should also be sent to the mailing | |
91 list. | |
92 | |
93 | |
94 o Please reread your patch before submitting it. | |
95 | |
96 | |
97 o If you send several unrelated changes together, we will | |
98 ask you to separate them so we can consider each of the changes | |
99 by itself. | |
100 | |
101 | |
102 o Supplemental information for Emacs Developers: | |
103 | |
104 Once you become a frequent contributor to Emacs, we can | |
105 consider giving you write access to the CVS repository. | |
106 | |
107 Discussion about Emacs development takes place on | |
108 emacs-devel@gnu.org. | |
109 | |
110 Think carefully about whether your change requires updating the | |
111 documentation. If it does, you can either do this yourself or | |
112 add an item to the NEWS file. | |
113 | |
114 The best way to understand Emacs Internals is to read the code | |
115 but the nodes "Tips" and "GNU Emacs Internals" in the Appendix | |
116 of the Emacs Lisp Reference Manual may also help. | |
117 | |
118 The file DEBUG describes how to debug Emacs bugs. | |
119 | |
120 Avoid using `defadvice' or `eval-after-load' for Lisp | |
121 code to be included in Emacs. |