diff options
| author | Robert Pluim <rpluim@gmail.com> | 2024-09-11 18:09:29 +0200 |
|---|---|---|
| committer | Robert Pluim <rpluim@gmail.com> | 2024-09-13 14:07:17 +0200 |
| commit | b4863908623b739b0771a70c7cc4f4a57d07a841 (patch) | |
| tree | b8cd97d705b5b055ef6f85f120b067ebbebe0870 /CONTRIBUTE | |
| parent | 7376623a244a91d1de5245645b4b3e8c9469d422 (diff) | |
Add notes about documenting default values
* CONTRIBUTE: Ask people to document default values when adding new user
options.
Diffstat (limited to 'CONTRIBUTE')
| -rw-r--r-- | CONTRIBUTE | 7 |
1 files 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. |