Author Topic: [ATTENTION: PLEASE READ] Bug Submission Guidelines  (Read 7513 times)

Offline i2amroy

  • Contributor
  • Survivor
  • ****
  • Posts: 2772
  • Cats, ruling the world one dwarf at a time
    • View Profile
[ATTENTION: PLEASE READ] Bug Submission Guidelines
« on: October 18, 2013, 10:47:24 PM »
Since we have a larger number of players who are generous enough to act as free bug testers, here are some basic guidelines to follow when posting bug reports. Please include these things at the top of your post:

1) The version you are using. This should be the version number followed by either "stable" ("0.8 stable") or followed by the ending digits of the version number displayed on the title screen. (If the title screen displays "0.8-1649-g5ff625d" then please post "0.8 g5ff625d"). Github sorts by the last digits so it's much easier to track down what exact version you are using if we know them.
2) Whether you are using The Curses or SDL versions of the game. If you can turn on tiles you are using the SDL version, if switching that option does nothing you are using the Curses one.
3) What OS you are running. This one isn't as important, but if you are reporting a crash please make sure to include it.
4) If your bug involves translation or string errors please post the system locale as well.

So an example post would look like this:

0.8 g40b731
SDL
Windows 7

*Insert post content here*

Lastly, while it's sometimes helpful to post multiple tiny bugs in a single thread, please do not revive older "multiple bug" threads to report new bugs, as it quickly becomes difficult to tell which have been fixed yet or not. Instead just simply make a new thread, it keeps things much cleaner and easier to understand.

Thank you for cooperating, by doing this you are enabling us to responds more quickly to bug reports and enable them to be fixed faster; therefore making Cataclysm a better and bug-free game for all of us.
« Last Edit: April 12, 2015, 10:13:56 PM by i2amroy »

Offline Zireael

  • Survivor
  • ***
  • Posts: 1973
    • View Profile
Re: PLEASE READ! Important Bug reporting information
« Reply #1 on: October 19, 2013, 08:27:01 AM »
Why don't you stick this thread?

Offline Faene

  • Zombie Food
  • *
  • Posts: 10
    • View Profile
Re: [ATTENTION: PLEASE READ] Bug Submission Guidelines
« Reply #2 on: October 20, 2013, 10:32:08 PM »
Should we post the system locale too, or that doesn't matter?

Offline i2amroy

  • Contributor
  • Survivor
  • ****
  • Posts: 2772
  • Cats, ruling the world one dwarf at a time
    • View Profile
Re: [ATTENTION: PLEASE READ] Bug Submission Guidelines
« Reply #3 on: October 22, 2013, 06:48:56 PM »
Should we post the system locale too, or that doesn't matter?
It should only matter in translation or string errors (and the hopefully fixed decimal point problem), and I've updated the OP to reflect accordingly.

Offline Soyweiser

  • Survivor
  • ***
  • Posts: 864
    • View Profile
Re: [ATTENTION: PLEASE READ] Bug Submission Guidelines
« Reply #4 on: March 16, 2014, 07:51:43 PM »
If you get a debug message, it is usually worthwhile to list the entire debug message, as they contain some information where the error occurs in the code. This helps devs a lot in locating the code that is bugging.
"Put me in charge and you'll have finished and polished game with hundreds more new features within two months." -- Lazycat
"Voker57 just was wondering about when did cata turn into contact lenses user simulator"

Offline Pandromidal

  • NPC
  • **
  • Posts: 185
    • View Profile
Re: [ATTENTION: PLEASE READ] Bug Submission Guidelines
« Reply #5 on: March 13, 2015, 07:17:49 PM »
It would be nice to rename the title of the bug to include "fixed", "by design", etc when the issue has been resolved. Of course perhaps that's asking too much of people.

Offline KA101

  • Administrator
  • Survivor
  • *****
  • Posts: 6858
    • View Profile
Re: [ATTENTION: PLEASE READ] Bug Submission Guidelines
« Reply #6 on: March 15, 2015, 04:08:42 AM »
It would be nice to rename the title of the bug to include "fixed", "by design", etc when the issue has been resolved. Of course perhaps that's asking too much of people.

Topic creators can mod the titles of topics they create, as can admins, so this is workable.  May take a while for momentum to build up though.  :-/