From: Glenn Morris Date: Mon, 16 Sep 2013 18:37:18 +0000 (-0400) Subject: * etc/CONTRIBUTE: Copyedits. X-Git-Tag: emacs-24.3.90~173^2^2~42^2~45^2~387^2~1593^2 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=16af23266cd8671281d89ebb2c15d3acac7ba914;p=emacs.git * etc/CONTRIBUTE: Copyedits. --- diff --git a/etc/CONTRIBUTE b/etc/CONTRIBUTE index c9d84a8d5a2..5d6b4238c97 100644 --- a/etc/CONTRIBUTE +++ b/etc/CONTRIBUTE @@ -99,8 +99,7 @@ revise your patch, send it as a followup to the initial topic. ** Description -For bug fixes, a description of the bug and how your patch fixes this -bug. +For bug fixes, a description of the bug and how your patch fixes it. For new features, a description of the feature and your implementation. @@ -108,7 +107,7 @@ For new features, a description of the feature and your implementation. A ChangeLog entry as plaintext (separate from the patch). -See the various ChangeLog files for format and content. Note that, +See the existing ChangeLog files for format and content. Note that, unlike some other projects, we do require ChangeLogs also for documentation, i.e. Texinfo files. @@ -117,24 +116,16 @@ Manual, for how to write good log entries. ** The patch itself. -Please use "Context Diff" format. - If you are accessing the Bazaar repository, make sure your copy is up-to-date (e.g. with `bzr pull'), then use bzr diff --no-aliases --diff-options=-cp Else, use diff -cp OLD NEW -If your version of diff does not support these options, then get the -latest version of GNU Diff. - ** Mail format. -We prefer to get the patches as inline plain text. - -Please be aware of line wrapping which will make the patch unreadable -and useless for us. To avoid that, you can use MIME attachments or, -as a last resort, uuencoded gzipped text. +We prefer to get the patches as plain text, either inline (be careful +your mail client does not change line breaks) or as MIME attachments. ** Please reread your patch before submitting it. @@ -184,18 +175,12 @@ by following links from http://savannah.gnu.org/mail/?group=emacs . ** Document your changes. -Think carefully about whether your change requires updating the -documentation. If it does, you can either do this yourself or add an -item to the NEWS file. - -If you document your change in NEWS, please mark the NEWS entry with -the documentation status of the change: if you submit the changes for -the manuals, mark it with "+++"; if it doesn't need to be documented, -mark it with "---"; if it needs to be documented, but you didn't -submit documentation changes, leave the NEWS entry unmarked. (These -marks are checked by the Emacs maintainers to make sure every change -was reflected in the manuals.) +Any change that matters to end-users should have a NEWS entry. +Think about whether your change requires updating the documentation +(both manuals and doc-strings). If you know it does not, mark the NEWS +entry with "---". If you know that *all* the necessary documentation +updates have been made, mark the entry with "+++". Otherwise do not mark it. ** Understanding Emacs Internals.