Re: Making GNOME CVS more usable

[John Kodis <kodis jagunet com>]

On Mon, Mar 26, 2001 at 03:14:02PM +0200, Matthias Warkus wrote:

> Every module on GNOME CVS should contain a file, called maybe
> "SYNOPSIS" or such, describing in a short paragraph just what that
> module is and does. I propose also adding a file "REQUIRES",
> describing all other CVS modules and/or external libraries the
> module requires.

These are both excellent ideas.  Many projects have README files that
contain full details of all the obscure bugs fixed in the last
micro-revision of the project, but completely lack any hint as to what
purpose the program serves.  This, combined with the somewhat fanciful
names favored by many projects make it difficult to know whether for
example, the Gnome-fudgewaffle program is an IRC client, a tetris
clone, an enterprise resource planning system, or something completly
different.

Since you'll be going through all the CVS modules anyway, this would
also be a good time to decide whether the HACKING file should be named
HACKING or README.cvs-commits, and normalize that as well.

-- John Kodis.