]> git.eshelyaron.com Git - emacs.git/commitdiff
Add notes about documenting default values
authorRobert Pluim <rpluim@gmail.com>
Wed, 11 Sep 2024 16:09:29 +0000 (18:09 +0200)
committerEshel Yaron <me@eshelyaron.com>
Sat, 14 Sep 2024 20:30:06 +0000 (22:30 +0200)
* CONTRIBUTE: Ask people to document default values when adding new user
  options.

(cherry picked from commit b4863908623b739b0771a70c7cc4f4a57d07a841)

CONTRIBUTE

index 7c5c07771eb0ace039a2d1561c2e0d5942056955..96113d658b894e407c06087047e147a2651d2107 100644 (file)
@@ -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.