de5@STC06.CTD.ORNL.GOV (SILL D E) (08/21/90)
[This is tut.cis.ohio-state.edu:pub/gnu/emacs/elisp-archive/guidelines]
Guidelines for Submitting Code to the Elisp Archive
1. Documentation.
The preferred documentation is:
o Description of intended purpose
o Installation instructions
o Usage instructions
o Known bugs
o File header including:
-author's name and address
-file name
-version number (optional)
-date
-copyright notice (optional)
Scale the documentation as required; don't write a book for a
five-line function, don't submit 100k of code with no
instructions.
2. Copyright
I recommend the inclusion of a copyright notice that specifically
allows others to copy, modify, and redistribute your code. For an
example, see the GNU Emacs General Public License (in Emacs: C-h
C-c).
3. Packaging
Original submissions should be submitted in their entirety;
modifications to parts of the standard Emacs distribution or
previously archived code should be submitted as "diffs".
Multifile submissions should be packaged as a tar or shar archive.
Filenames should not exceed 14 characters, or 13 characters for
".el" files. System V truncates names to 14 characters, so when
Emacs tries to make a 15 character ".elc" file during byte-
compilation the result is that the ".el" file is destroyed.
4. Submission
Mail your package to me at de5@ornl.gov if it's not too big and
it's text. Otherwise, either send me instructions for anonymously
ftp'ing it off your system or break it into a number of smaller,
mail-sized pieces. If you have any questions about what to do,
drop me a line.
5. Lisp Code Directory Record
In order to make the Archives easier to use, and to lighten the
load of the Lisp Code Directory maintainer, please include an LCD
record with your submission. This record is a one-line string of
text that includes various information about your code. See the
file pub/gnu/emacs/elisp-archive/lispdir.doc.Z for more
information about the LCD. See LCD-datafile.Z in the same
directory for the current format of the file. The first record
lists the names of the fields in each record.
Dave Sill
de5@ornl.gov
Elisp Archive Coordinator