X-Git-Url: https://jxself.org/git/?p=super-star-trek.git;a=blobdiff_plain;f=doc%2FHACKING;h=0ec0784a8e174079f9d819feee310caeff076bf4;hp=93c0df68d136ba983ee5a707e1579f48bf1c6b51;hb=bc69fb7fa05669a28d94f087f1eaf3e4a937bad6;hpb=0e91d76d5d2dd36b5c650e25ccd4fa806de3a55b diff --git a/doc/HACKING b/doc/HACKING index 93c0df6..0ec0784 100644 --- 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 @@ -217,7 +219,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: