]> git.eshelyaron.com Git - emacs.git/commitdiff
; CONTRIBUTE: Add a couple of nits.
authorEli Zaretskii <eliz@gnu.org>
Mon, 18 Jun 2018 16:34:55 +0000 (19:34 +0300)
committerEli Zaretskii <eliz@gnu.org>
Mon, 18 Jun 2018 16:34:55 +0000 (19:34 +0300)
CONTRIBUTE

index c324375bb07134a54b5fe525bb64ef05f1a8b056..c4f424ce560f5712ae3c69a6dd3610cc80f749af 100644 (file)
@@ -78,9 +78,16 @@ admin/notes/bug-triage.
 ** Documenting your changes
 
 Any change that matters to end-users should have an entry in etc/NEWS.
+Try to start each NEWS entry with a sentence that summarizes the entry
+and takes just one line -- this will allow to read NEWS in Outline
+mode after hiding the body of each entry.
 
 Doc-strings should be updated together with the code.
 
+New defcustom's should always have a ':version' tag stating the first
+Emacs version in which they will appear.  Likewise with defcustom's
+whose value is changed -- update their ':version' tag.
+
 Think about whether your change requires updating the manuals.  If you
 know it does not, mark the NEWS entry with "---".  If you know
 that *all* the necessary documentation updates have been made as part