diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2018-06-18 19:34:55 +0300 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2018-06-18 19:34:55 +0300 |
| commit | d8bff5305b83d15f1a000de988b3c1f6a0803425 (patch) | |
| tree | bf36dbee3808640b5d3fc88723b565c44cd0d7b3 /CONTRIBUTE | |
| parent | 48829cba2168bcf8bfe2301ebe694b37152a7959 (diff) | |
| download | emacs-d8bff5305b83d15f1a000de988b3c1f6a0803425.tar.gz | |
; CONTRIBUTE: Add a couple of nits.
Diffstat (limited to 'CONTRIBUTE')
| -rw-r--r-- | CONTRIBUTE | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/CONTRIBUTE b/CONTRIBUTE index c324375bb07..c4f424ce560 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE @@ -78,9 +78,16 @@ admin/notes/bug-triage. ** Documenting your changes 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 to read NEWS in Outline +mode after hiding the body of each entry. Doc-strings should be updated together with the code. +New defcustom's should always have a ':version' tag stating the first +Emacs version in which they will appear. Likewise with defcustom's +whose value is changed -- update their ':version' tag. + Think about whether your change requires updating the manuals. If you know it does not, mark the NEWS entry with "---". If you know that *all* the necessary documentation updates have been made as part |