admin/notes/newfile

   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).
   9 Run the `doschk' program like this:
  10
  11     find /path/to/emacs -print | doschk
  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.
  17
  18 ** Make the ChangeLog entry in the name of the author(s), not your own name.
  19
  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).