procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; CONTRIBUTE: Add a couple of nits.

Browse source
This commit is contained in:
Eli Zaretskii 2018-06-18 19:34:55 +03:00
parent 48829cba21
commit d8bff5305b
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTE
View file

@ -78,9 +78,16 @@ admin/notes/bug-triage.
** Documenting your changes ** Documenting your changes
Any change that matters to end-users should have an entry in etc/NEWS. 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. 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 Think about whether your change requires updating the manuals. If you
know it does not, mark the NEWS entry with "---". If you know know it does not, mark the NEWS entry with "---". If you know
that *all* the necessary documentation updates have been made as part that *all* the necessary documentation updates have been made as part