HCoop / bpt / guile.git / blame
| Commit | Line | Data |
|---|---|---|
| 795b4217 JB |
1 | Here are some guidelines for working on the Guile source tree at GNU. |
| 2 | ||
| 3 | - As for any part of Project GNU, changes to Guile should follow the | |
| 4 | GNU coding standards. The standards are available via anonymous FTP | |
| 80b4c4fc JB |
5 | from prep.ai.mit.edu, as /pub/gnu/standards/standards.texi and |
| 6 | make-stds.texi. | |
| 795b4217 JB |
7 | |
| 8 | - Make sure your changes compile and work, at least on your own | |
| 9 | machine, before checking them into the main branch of the Guile | |
| 10 | repository. If you really need to check in untested changes, make a | |
| 11 | branch. | |
| 12 | ||
| 13 | - When you make a user-visible change (i.e. one that should be | |
| 14 | documented, and appear in NEWS, put an asterisk in column zero of the | |
| 15 | start of the ChangeLog entry, like so: | |
| 16 | ||
| 17 | Sat Aug 3 01:27:14 1996 Gary Houston <ghouston@actrix.gen.nz> | |
| 18 | ||
| 19 | * * fports.c (scm_open_file): don't return #f, throw error. | |
| 20 | ||
| 21 | - Include each log entry in both the ChangeLog and in the CVS logs. | |
| 22 | If you're using Emacs, the pcl-cvs interface to CVS has features to | |
| 23 | make this easier; it checks the ChangeLog, and generates good default | |
| 24 | CVS log entries from that. | |
| 25 | ||
| 26 | - If you add or remove files, don't forget to update the 'dist-dir' | |
| 27 | target in the relevant Makefile.in files, so the snapshot and | |
| 28 | distribution processes will work. | |
| 29 | ||
| 30 | - Make sure you have papers from people before integrating their | |
| 31 | changes or contributions. This is very frustrating, but very | |
| 32 | important to do right. From maintain.texi, "Information for | |
| 33 | Maintainers of GNU Software": | |
| 34 | ||
| 35 | When incorporating changes from other people, make sure to follow the | |
| 36 | correct procedures. Doing this ensures that the FSF has the legal | |
| 37 | right to distribute and defend GNU software. | |
| 38 | ||
| 39 | For the sake of registering the copyright on later versions ofthe | |
| 40 | software you need to keep track of each person who makes significant | |
| 41 | changes. A change of ten lines or so, or a few such changes, in a | |
| 42 | large program is not significant. | |
| 43 | ||
| 44 | *Before* incorporating significant changes, make sure that the person | |
| 45 | has signed copyright papers, and that the Free Software Foundation has | |
| 46 | received them. | |
| 47 | ||
| 48 | If you receive contributions you want to use from someone, let me know | |
| 49 | and I'll take care of the administrivia. Put the contributions aside | |
| 50 | until we have the necessary papers. | |
| 51 | ||
| 52 | ||
| 53 | ||
| 54 | Jim Blandy |