Within the code itself, here's how you should comment your changes.
//csc_052905_1 doThis();
doThat(); //csc_052905_1
This makes it easy to see that I commented out the first line and
replaced it with the second one. Of course additional comments can
always be added to make the intent of the change clear (ie. why are the
changes being made).
In the case of multiple line changes, I'll often do something like this:
//csc_052905_1_start - fix broken logic;
should be using for loop instead
// doThis1();
// doThis2();
// doThis3();
for (int i=0; i<100; i++) {
doThat1();
}
//csc_052905_1_end
Here its easy to see what happened: the first three lines were
commented out, and replaced by a simple for loop. Of course, it would
also be helpful to explain WHY the changes were made.
----------------------------------------------------------------------------------------------------
csc_112805_2 - Moved the /docs tree to /docs_old in prep for new updated
docs.
Once you've done this, run the unit tests to be sure everything passes muster, then .zip all your files you've changed and send them to the list. You should always provide a detailed explanation of what you have changed and why. A committer will review your changes and then apply them to the tree when he/she feels they are ok. Pretty easy, eh?