From c7ca984da05466dd0132cd3750768fcea7232373 Mon Sep 17 00:00:00 2001 From: Robert Pluim Date: Wed, 11 Sep 2024 18:09:29 +0200 Subject: [PATCH] Add notes about documenting default values * CONTRIBUTE: Ask people to document default values when adding new user options. (cherry picked from commit b4863908623b739b0771a70c7cc4f4a57d07a841) --- CONTRIBUTE | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) 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. -- 2.39.5