diff options
| author | Robert Pluim | 2024-09-11 18:09:29 +0200 |
|---|---|---|
| committer | Robert Pluim | 2024-09-13 14:07:17 +0200 |
| commit | b4863908623b739b0771a70c7cc4f4a57d07a841 (patch) | |
| tree | b8cd97d705b5b055ef6f85f120b067ebbebe0870 | |
| parent | 7376623a244a91d1de5245645b4b3e8c9469d422 (diff) | |
| download | emacs-b4863908623b739b0771a70c7cc4f4a57d07a841.tar.gz emacs-b4863908623b739b0771a70c7cc4f4a57d07a841.zip | |
Add notes about documenting default values
* CONTRIBUTE: Ask people to document default values when adding new user
options.
| -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. | |||
| 110 | 110 | ||
| 111 | Any change that matters to end-users should have an entry in etc/NEWS. | 111 | Any change that matters to end-users should have an entry in etc/NEWS. |
| 112 | Try to start each NEWS entry with a sentence that summarizes the entry | 112 | Try to start each NEWS entry with a sentence that summarizes the entry |
| 113 | and takes just one line -- this will allow reading NEWS in Outline | 113 | and takes just one line -- this will allow reading NEWS in Outline mode |
| 114 | mode after hiding the body of each entry. | 114 | after hiding the body of each entry. When adding a new user option that |
| 115 | allows changing behavior, please document its default value. Similarly, | ||
| 116 | changes to the default value of an existing user option should be | ||
| 117 | announced. | ||
| 115 | 118 | ||
| 116 | Doc-strings should be updated together with the code. | 119 | Doc-strings should be updated together with the code. |
| 117 | 120 | ||