From: Robert Pluim <rpluim@gmail.com>
Date: Wed, 11 Sep 2024 16:09:29 +0000 (+0200)
Subject: Add notes about documenting default values
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c7ca984da05466dd0132cd3750768fcea7232373;p=emacs.git

Add notes about documenting default values

* CONTRIBUTE: Ask people to document default values when adding new user
  options.

(cherry picked from commit b4863908623b739b0771a70c7cc4f4a57d07a841)
---

diff --git a/CONTRIBUTE b/CONTRIBUTE
index 7c5c07771eb..96113d658b8 100644
--- a/CONTRIBUTE
+++ b/CONTRIBUTE
@@ -110,8 +110,11 @@ admin/notes/bug-triage.
 
 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 reading NEWS in Outline
-mode after hiding the body of each entry.
+and takes just one line -- this will allow reading NEWS in Outline mode
+after hiding the body of each entry.  When adding a new user option that
+allows changing behavior, please document its default value.  Similarly,
+changes to the default value of an existing user option should be
+announced.
 
 Doc-strings should be updated together with the code.