diff options
| author | Eli Zaretskii | 2006-07-07 11:20:50 +0000 |
|---|---|---|
| committer | Eli Zaretskii | 2006-07-07 11:20:50 +0000 |
| commit | 014a250c243bfcfb6a1900ea0f1b93a2624a069a (patch) | |
| tree | 0299d3b0d803ec96fb0b116ba59663f8267a1a98 | |
| parent | 2faacff7d9e783cea70015e36651b1c34ab82c8d (diff) | |
| download | emacs-014a250c243bfcfb6a1900ea0f1b93a2624a069a.tar.gz emacs-014a250c243bfcfb6a1900ea0f1b93a2624a069a.zip | |
Slight formatting changes and typo fixes. Add description of NEWS markings.
| -rw-r--r-- | CONTRIBUTE | 62 | ||||
| -rw-r--r-- | ChangeLog | 5 |
2 files changed, 42 insertions, 25 deletions
diff --git a/CONTRIBUTE b/CONTRIBUTE index 6d30fc14baa..8b69ccd0983 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE | |||
| @@ -34,13 +34,13 @@ o Coding Standards | |||
| 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 | ||
| @@ -52,11 +52,13 @@ 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 | ||
| @@ -66,27 +68,28 @@ o Submitting Patches | |||
| 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. |
| @@ -114,11 +117,20 @@ o Supplemental information for Emacs Developers: | |||
| 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. |
| @@ -1,3 +1,8 @@ | |||
| 1 | 2006-07-07 Eli Zaretskii <eliz@gnu.org> | ||
| 2 | |||
| 3 | * CONTRIBUTE: Slight formatting changes and typo fixes. Add | ||
| 4 | description of NEWS markings. | ||
| 5 | |||
| 1 | 2006-07-07 Kim F. Storm <storm@cua.dk> | 6 | 2006-07-07 Kim F. Storm <storm@cua.dk> |
| 2 | 7 | ||
| 3 | * CONTRIBUTE: Mention INSTALL.CVS. | 8 | * CONTRIBUTE: Mention INSTALL.CVS. |