HOWTO: Reporting a bug

(previously 'DEVELOPER') Private forum for registered community members. To register, please visit www.prison-architect.com/register.

Moderator: NBJeff

User avatar
jelco
level5
level5
Posts: 6018
Joined: Sat Feb 18, 2006 7:45 am
Location: Cygnus X-1
Contact:

HOWTO: Reporting a bug

Postby jelco » Wed Sep 26, 2012 4:13 pm

Alright, here's an edited copy-paste of my previous bug-reporting howto from Multiwinia to get things going in a structured manner.

Keep bug reports and feature requests inside the Developer forum. The General forum can be used for sharing screenshots or funny stories, but not for alpha issues.

  • Ask yourself the question if it is really a bug you want to report, or a feature request. These are different things and should be reported differently.
  • Update your drivers. These will usually be your graphics card drivers. Update them regardless of whether they're the newest version, there might be a corrupted file in there which an update will probably fix. (ATI/AMD, nVidia, SiS, Intel (Use the 'Graphics' tab on the right), else visit computer maker website)
  • Update DirectX. Easy enough.
  • Search the forums. Problems are rarely unique to one person and for that reason it is likely that someone else has encountered this same problem as you are experiencing. Use the Search form to search the Developer forum for your bug. If you encounter a topic which describes your problem, don't start a new one. If the problem was solved in that topic, read closely and see if you can solve the problem with the information supplied in that topic. If it is still unsolved, post in the topic to say that you have the problem too and supply the data layed out on the next bullet point for a bug report. Pay attention to the age of the topic and the version of the game it concerns - if a patch has been released since the topic was created, it can be helpful to say that the problem persists in the current version and hasn't been fixed by patches.
  • If the problem persists, post a topic specifying the following information:

    Windows/Mac version (including 32/64bit and service packs)
    CPU
    RAM (details not needed, amount of memory will suffice)
    Graphics card (including driver version)

    Include debug.txt which can be found here:
    On Windows 7 or Vista: C:\Users\<username>\AppData\Local\Introversion\Prison Architect\
    On Windows XP: C:\Documents and Settings\<username>\Local Settings\Application Data\Introversion\Prison Architect\
    On Mac OS X: ~/Library/Application Support/Prison Architect

    Furthermore, your dxdiag. This is a file that contains just about everything there is to know about your system and will help others immensely when trying to find the problem. Obtain and post your dxdiag like so (nicked from frenchfrog):

      1)'Start' windows button
      2)'Run ...' or the search bar in Vista
      3)Type 'dxdiag.exe' in the 'Open' textbox and press the 'Ok' button
      4)Once the 'dxdiag.exe' dialog is up, click the 'Save All Information ...' button.
      5)Choose a destination for the file (ie: your desktop) and a name for the file (ie: 'dxdiag_info.txt')
      6)Post the content of the file either:
      • In an archive file, linked (preferably this option, because it doesn't clutter the topic as much)
      • Inbetween [code][/code] tags to make it easily identifiable
      If you posted your dxdiag before and you haven't made big changes to your system configuration (either hardware or software), linking to the post where your dxdiag was posted is preferred as opposed to spamming every bug report you make with your dxdiag.
    Also supply a detailed description of the problem and information that could be of use regarding the subject. Simply saying "My mouse doesn't work" will not help you a lot. If we continue this example, it'd be a good idea to mention the type of mouse you have, are you running the game in windowed mode, does it only work in the menus or not at all, etc.


A good bug report is specific but not too short. ;)

Finally, make sure your topic title is descriptive and understandable, while bearing in mind the character limit these forums have on topic titles. It will make it easier for other people who are searching for a topic with a similar problem as their own to find the proper topic if the topic titles are clear as to what the bug reported in the topic is.

Following these steps will give the other people a lot of information.

Good luck with your problems, hopefully they will get fixed quickly. ;) Any suggestions for this list can be posted in this topic.

Jelco[/b]
Last edited by jelco on Thu Sep 27, 2012 5:58 pm, edited 1 time in total.
RabidZombie
level5
level5
Posts: 2414
Joined: Fri Nov 18, 2005 10:09 pm

Postby RabidZombie » Thu Sep 27, 2012 1:25 pm

One thing I'd suggest to make bugs reports easy to find is to give every bug report it's own thread. Threads full of different bug reports make the bug difficult to discuss and difficult to find.

Edit: Also, a good framework for reporting bugs is:

<Description>

Steps to reproduce:
<blah>

Expected:
- <blah>

Result:
- <blah>

Notes:
<Possibly relevant information>
<DXDIAG>

It presents everything in an easily readable way, and works as a pretty good check list for necessary information.
User avatar
Montyphy
level5
level5
Posts: 6745
Joined: Tue Apr 19, 2005 2:28 pm
Location: London, England

Postby Montyphy » Thu Sep 27, 2012 1:42 pm

Setting a useful subject line! "Bug report" is useless whereas "[OSX] Application window issue" or "[Win7] Prisoner punching prisoners through doors" are really helpful to people wanting to find if their problem has already been reported.
Uplink help: Check out the Guide or FAQ.
Latest Uplink patch is v1.55.
User avatar
Hessen
level3
level3
Posts: 291
Joined: Wed Sep 26, 2012 7:47 pm
Location: Swindon, England

Postby Hessen » Fri Oct 05, 2012 4:34 pm

Guessing this sticky is redundant now :)
User avatar
jelco
level5
level5
Posts: 6018
Joined: Sat Feb 18, 2006 7:45 am
Location: Cygnus X-1
Contact:

Postby jelco » Fri Oct 05, 2012 4:40 pm

Posting bugs should still happen in a structured manner to be useful. Just because the forum isn't the place to do it anymore doesn't mean the contents aren't still relevant. ;)

Jelco
"The ships hung in the sky much the same way that bricks don't."
- Douglas Adams
User avatar
Hessen
level3
level3
Posts: 291
Joined: Wed Sep 26, 2012 7:47 pm
Location: Swindon, England

Postby Hessen » Sat Oct 06, 2012 12:50 am

Structured yes of course, but some of the wording in the OP relates to posting bugs on the forum rather than using the tool.

Return to “Community Members”

Who is online

Users browsing this forum: No registered users and 1 guest