[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] emacs-26 d8bff53 1/2: ; CONTRIBUTE: Add a couple of nits.
From: |
Eli Zaretskii |
Subject: |
[Emacs-diffs] emacs-26 d8bff53 1/2: ; CONTRIBUTE: Add a couple of nits. |
Date: |
Mon, 18 Jun 2018 12:40:07 -0400 (EDT) |
branch: emacs-26
commit d8bff5305b83d15f1a000de988b3c1f6a0803425
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>
; CONTRIBUTE: Add a couple of nits.
---
CONTRIBUTE | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/CONTRIBUTE b/CONTRIBUTE
index c324375..c4f424c 100644
--- a/CONTRIBUTE
+++ b/CONTRIBUTE
@@ -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