Documented the new CVS template. This really isn't the right place for it,
but I wanted to get this out for review without an interminable debate about where it really should go.
This commit is contained in:
parent
99fa41fb52
commit
3a5140872f
44
CVS-INFO
Normal file
44
CVS-INFO
Normal file
@ -0,0 +1,44 @@
|
||||
$FreeBSD$
|
||||
|
||||
This file really doesn't belong here, but I wanted to elicit comment
|
||||
without starting a discussion as to where it really does belong.
|
||||
Anyway, here goes...
|
||||
|
||||
When the new CVS tree was set up back in May, I wanted to ensure that
|
||||
everybody at least gave some thought to asking other people to look at
|
||||
code before it is committed. Since we have had a number of rancorous
|
||||
discussions in the past about both committing code prematurely, and
|
||||
committing code that was written by someone else, I decided to use the
|
||||
`template' function of CVS to give people a chance to think about it.
|
||||
|
||||
The template looks like this:
|
||||
|
||||
Reviewed by:
|
||||
Submitted by:
|
||||
CVS: ----------------------------------------------------------------------
|
||||
CVS: Delete the ``Reviewed by'' line if this is somebody else's work
|
||||
CVS: (you are the reviewer).
|
||||
CVS: Delete the ``Submitted by'' line if this is NOT somebody else's
|
||||
CVS: work (you are the author).
|
||||
|
||||
If you are making substantial or possibly controversial changes to the
|
||||
code, please talk to someone else who either has commit authority, or
|
||||
who is recognized as an expert in the BSD community. This latter
|
||||
category includes the author of the program or subsystem you're
|
||||
modifying, like Rick Macklem for the NFS code, or Keith Bostic for
|
||||
`vi'.
|
||||
|
||||
If the changes are insubstantial and noncontroversial (e.g., fixing
|
||||
spelling errors, or most Makefile changes) there is no need for
|
||||
review. Please delete the ``Reviewed by:'' line, though, so that the
|
||||
logs look cleaner.
|
||||
|
||||
If you are committing code or modifications which were originally done
|
||||
by some other person or group, them please please please make sure to
|
||||
credit them in the ``Submitted by'' line. In this case, you are
|
||||
considered to be the reviewer. If it is your own code, or that of
|
||||
another team member, then you should delete the ``Submitted by'' line,
|
||||
so that the logs look cleaner.
|
||||
|
||||
-GAWollman
|
||||
|
Loading…
Reference in New Issue
Block a user