home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / geo250.zip / REPORT.BUG < prev    next >
Text File  |  1995-10-08  |  5KB  |  119 lines
  1. ______________________________________________________________________
  2.  
  3.               HOW TO REPORT BUGS OR PROBLEMS WITH GOLDED
  4. ______________________________________________________________________
  5.  
  6.  
  7.  ┌─────────────────────────────────────────────────────────────────┐
  8.  │ PLEASE READ THIS DOCUMENT UNTIL YOU GET ALL THE WAY TO THE END! │
  9.  └─────────────────────────────────────────────────────────────────┘
  10.  
  11.  
  12. In order to maximize my time to handle as many bugs and feature
  13. additions as possible, it is very important that these instructions
  14. are followed. I can NOT afford to take the time to go hunting for lose
  15. files that people send, or chasing people who do not give me a
  16. complete archive as per this document - if you can't send me what I
  17. need, a lot of effort, yours and mine, may be wasted without results.
  18.  
  19. When sending me bug reports, I will need the following data from you:
  20.  
  21. *   A README.1ST file describing the problem in as much detail as you
  22.     can give. Preferrably including a step-by-step description of how
  23.     to reproduce the problem on your setup.
  24.  
  25. *   The version of GoldED that you are using, including main version
  26.     (X.YY), Alpha/Beta/Gamma number (Ammdd, BetaN, etc) and platform
  27.     (DOS, 386 or OS/2). Whether or not you have applied any patches to
  28.     the EXE file(s).
  29.  
  30. *   Complete copies of your GOLDED.CFG, GOLDAREA.CFG, GOLDRAND.CFG and
  31.     all files included from these. If the problem is related to
  32.     keyboard, language or help system, also the GOLDKEYS.CFG,
  33.     GOLDLANG.CFG or GOLDHELP.CFG files. If the problem is related to
  34.     character translation, I need copies of the relevant .CHS or .ESC
  35.     files.
  36.  
  37. *   The GOLDAREA.INC file and a file with the redirected screen output
  38.     of GoldED when you run it with the parameters -FF -VV -W. The -W
  39.     parameter tells GoldED to make the GOLDAREA.INC file, which dumps
  40.     the complete area configuration known by GoldED.
  41.  
  42. *   A copy of the batch or cmd file (if any) you use to run GoldED.
  43.  
  44. *   Your setting of the GOLDED and GEDCMD environment variables.
  45.  
  46. *   If there are problems with GoldNODE, I need a screen dump of the
  47.     output when GoldNODE stops. Your setting of the GOLDNODE
  48.     environment variable. If GoldNODE reads a different configuration
  49.     file than GOLDED.CFG, I need a copy of the different configuration
  50.     file.
  51.  
  52. *   If there are problems with nodelists and/or nodelist indexes, I
  53.     need to known the program name and version of the nodelist
  54.     compiler you used. Try other nodelist compilers and tell me what,
  55.     if any, difference it made. For problems with "othernet"
  56.     nodelists, I may need copies of the nodelists.
  57.  
  58. *   If there are problems with another programs configuration (using
  59.     the AREAFILE keyword), I need the relevant configuration files
  60.     from the other program, and the name and version number of it.
  61.  
  62. *   If there are problems with a particular message or a set of
  63.     messagebase files, I need a copy of the message or messagebase
  64.     files.
  65.  
  66. *   If there are problems with QWK or SOUP packets, I need copies of
  67.     the packets.
  68.  
  69. *   A description of your hardware, installed and available memory,
  70.     operating environment (DOS, OS/2), any memory managers, special
  71.     TSR's etc.
  72.  
  73. *   A copy of your GoldED logfile, or relevant cuts from it.
  74.  
  75. *   If GoldED (2.50.A0715 or later) locks up, try running with the
  76.     debug parameter -X. This enables function tracking in the
  77.     statusline and may tell me approximately where in the program the
  78.     lockup occurred. Let me know what the statusline says in this
  79.     situation.
  80.  
  81. I can not stress enough the need for this archive to be complete, nor
  82. can I stress enough the need for INPUT files to work with. Output
  83. files does not me much good, since they do not let me trace GoldED in
  84. operation while running your configs and your input files.
  85.  
  86. Double check: Do you have all of the above files ready to go?
  87. Good. Place them into an archive, named uniquely for you. Do NOT call
  88. it "bugs.zip" or some such, as I can not identify it that way. Do NOT
  89. send your files "loose" (ie, not in a package), as OTHER PEOPLE may be
  90. doing it too, and I don't want to waste time sorting through my
  91. inbound.
  92.  
  93. If sending via email or file attach, I can handle most major archive
  94. formats.
  95.  
  96. You may now send your archive to me a variety of different ways:
  97.  
  98.   File attach to 2:236/77 (MODEM) or 2:236/1077 (ISDN).
  99.   Email uuencoded to odinn@ibm.net or odinn@winboss.dk.
  100.   Upload on my BBS in the GoldED file area.
  101.   Sorry, I have no FTP site for this purpose.
  102.   You can also send the data on a diskette, but please don't.
  103.  
  104. Please don't send the archive to any reg.site unless they say that
  105. they are ready to accept them. The reg.sites are not geared to, or can
  106. afford to, forward the archives to me.
  107.  
  108. Thank you for reading this far. With your help, we will all appreciate
  109. the increased productivity, which will translate to sooner bug fixes
  110. and enhancements.
  111.  
  112. Odinn Sorensen, 24. september 1995.
  113.  
  114. PS: Thanks to Jason Fesler, author of GIGO, for inspiration for this
  115. document.
  116.  
  117. ______________________________________________________________________
  118.  
  119.