Mercurial > emacs
annotate admin/notes/newfile @ 104341:f25cba6d7938
Checklist for adding new files to Emacs.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Tue, 18 Aug 2009 16:23:09 +0000 |
parents | |
children | f03eb2311295 |
rev | line source |
---|---|
104341
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
1 CHECKLIST FOR ADDING A NEW FILE TO EMACS -*- outline -*- |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
2 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
3 ** Make sure the author(s) have a copyright assignment/disclaimer. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
4 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
5 ** Make sure the file matches the standard Emacs template (header |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
6 format, copyright and license notice, etc). |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
7 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
8 ** Make sure the filename does not cause the DOS port any problems (8+3). |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
9 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
10 ** Make the ChangeLog entry in the name of the author(s), not your own name. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
11 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
12 ** If appropriate, add an entry to lisp/Makefile.in ELCFILES. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
13 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
14 ** If appropriate, check that the file compiles OK and that Emacs |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
15 builds fine with it. Address any compilation warnings. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
16 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
17 ** If a major contribution, consider adding an entry to the |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
18 Acknowledgments in doc/emacs/emacs.texi and ack.texi. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
19 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
20 ** If appropriate, add a short NEWS entry. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
21 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
22 ** If appropriate, update make-dist (not needed with "standard" file |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
23 names, eg *.el). |