[bpt/emacs.git] / admin / notes / newfile

CHECKLIST FOR ADDING A NEW FILE TO EMACS -*- outline -*-

** Make sure the author(s) have a copyright assignment/disclaimer.

** Make sure the file matches the standard Emacs template (header
format, copyright and license notice, etc).

** Make sure the filename does not cause the DOS port any problems (8+3).
Run the `doschk' program like this:

    find /path/to/emacs -print | doschk

and examine the output for DOS-related problems.  The sections of
output under the headings "The following files are not valid DOS file
names:" and "The following resolve to the same DOS file names:" should
not include any files that end up in the release tarball.

** Make the ChangeLog entry in the name of the author(s), not your own name.

** If appropriate, check that the file compiles OK and that Emacs
builds fine with it.  Address any compilation warnings.

** If a major contribution, consider adding an entry to the
Acknowledgments in doc/emacs/emacs.texi and ack.texi.

** If appropriate, add a short NEWS entry.

** If appropriate, update make-dist (not needed with "standard" file
names, eg *.el).
Commit	Line	Data
ffc90b85 GM	1	CHECKLIST FOR ADDING A NEW FILE TO EMACS -- outline --
	2
	3	** Make sure the author(s) have a copyright assignment/disclaimer.
	4
	5	** Make sure the file matches the standard Emacs template (header
	6	format, copyright and license notice, etc).
	7
	8	** Make sure the filename does not cause the DOS port any problems (8+3).
cb335806 EZ	9	Run the `doschk' program like this:
cb335806 EZ	10
0d722f98	11	find /path/to/emacs -print \| doschk
cb335806 EZ	12
	13	and examine the output for DOS-related problems. The sections of
	14	output under the headings "The following files are not valid DOS file
	15	names:" and "The following resolve to the same DOS file names:" should
	16	not include any files that end up in the release tarball.
ffc90b85 GM	17
	18	** Make the ChangeLog entry in the name of the author(s), not your own name.
	19
ffc90b85 GM	20	** If appropriate, check that the file compiles OK and that Emacs
	21	builds fine with it. Address any compilation warnings.
	22
	23	** If a major contribution, consider adding an entry to the
	24	Acknowledgments in doc/emacs/emacs.texi and ack.texi.
	25
	26	** If appropriate, add a short NEWS entry.
	27
	28	** If appropriate, update make-dist (not needed with "standard" file
	29	names, eg *.el).