X-Git-Url: https://jxself.org/git/?p=super-star-trek.git;a=blobdiff_plain;f=doc%2FHACKING;h=4bf7b496c5592d1a91fe0a566e321cf72bd8ee07;hp=93c0df68d136ba983ee5a707e1579f48bf1c6b51;hb=2daa8f43343334aa3180d6ed9a2725094c897932;hpb=0e91d76d5d2dd36b5c650e25ccd4fa806de3a55b

diff --git a/doc/HACKING b/doc/HACKING
index 93c0df6..4bf7b49 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -217,7 +217,26 @@ included in the distribution, 'replay', automatically reruns the
 last game you played.
 
 See the "test" directory for regression-test logs and checkfiles.
+Please run 'make check' every time you change this game to be sure
+you haven't broken anything.  
 
+When you fix a bug, add the log of the game that triggered it (and
+a checkfile) to the regression tests. This is how we improve the code
+coverage of the suite. 
+
+Two things to do to the log before dropping it in the test directory:
+
+(a) Strip out all lines beginning with "#curses:" - these are for debugging
+the curses interface and are not needed or regression testing; removing
+them makes it easier to see the game commands.
+
+(b) Add a header comment line explaining what the log is a test for.
+It should begin with "# Tests". This is what gets echoed before each
+regression test is run.
+
+Then drop it into the test directory and "make buildregress" to create
+the check file. (Don't forget to commit and push the log and checkfile
+to the repository.)
 
 NOTES ON THE PYTHON TRANSLATION: