Import SCORE command, tracking Tom Almy's change.

[super-star-trek.git] / doc / HACKING

diff --git a/doc/HACKING b/doc/HACKING
index 46c35425f41eb06a3da5be3898fabcfc5c07e8b3..0ec0784a8e174079f9d819feee310caeff076bf4 100644 (file)
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -210,6 +210,8 @@ and added more:
 the LRSCAN command is no longer needed.  (Controlled by OPTION_AUTOSCAN
 and turned off if game type is "plain" or "almy".)
 
+10. I imported Tom Almy's SCORE command from his 2013 version.
+
 TESTING:
 
 This code has been designed to be tested.  A simple shellscript
@@ -222,7 +224,21 @@ 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.
+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: