From: Eric S. Raymond <esr@thyrsus.com>
Date: Wed, 22 Feb 2012 22:02:44 +0000 (-0500)
Subject: Add test-suite instructions.
X-Git-Tag: 2.2~74
X-Git-Url: https://jxself.org/git/?p=super-star-trek.git;a=commitdiff_plain;h=2daa8f43343334aa3180d6ed9a2725094c897932;hp=5dafd738f43a117caf4fee0fe462e4e627dea4b2

Add test-suite instructions.
---

diff --git a/doc/HACKING b/doc/HACKING
index 46c3542..4bf7b49 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -222,7 +222,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: