It is currently Wed Sep 08, 2010 9:32 pm




Post new topic Reply to topic  [ 1 post ] 
HOW TO WRITE A BUG REPORT 
Author Message
User avatar

Joined: Sun Jan 04, 2009 4:49 pm
Posts: 543
Post HOW TO WRITE A BUG REPORT

1) Search before you post!
We really don't need to see a new bug report that is already reported. But if you find your bug is already reported, don't hesitate to reply and improve that bug report if you can!

2) Post title must take the following form: Image [version] problem
Good title examples:
[2.1.0.1434] Left-clicking a vertex and dragging it will cause a crash
[2.1.4.1922] Thing disappears after editing Thing properties in Visual Mode

To find the version number, open the Help menu and choose About, a dialog will appear with the version number on it. You can use the Copy Version button to copy it to the clipboard. If you can't start Doom Builder, then you can find the version by right-clicking on the executable (Builder.exe) and choose Properties. On Windows Vista the version number is on the Details tab, on Windows XP the version number is on the Version tab. For those who use the SVN: the last part of the version number is the SVN revision that the executable was built from.

3) Describe the problem and why this is unexpected behavior
The post title should be as obvious as possible, but will probably not suffice. So please describe the problem to the best of your abilities, explain what you expected the program to do and why this is unexpected behavior.

4) Include clear steps to reproduce the problem
If I cannot see the problem, I cannot fix it. You should provide clear steps to reproduce the problem.
Good example:
- Start program.
- Click File menu, then click Open File.
- Select file mymap.wad and click OK.
- Select configuration "Doom 2" and include Doom2.wad in the resources.
- Click OK.
- Drag the sector on the left to overlap with the sector on the right.
- Release drag button.

5) Put crash dumps in Code tags at the end of your report
If you get any crash information, copy and paste it at the end of your report and use Code tags.
Image
When you see this window, click the Details button and copy all text from the box that pops up.

Note: You can try pressing Continue after that to see if you can still save your work, but you should not report any more bugs in the same session after you pressed the Continue button. There is no guarantee that anything still works after it crashes, using the Continue button is completely at your own risk.

6) ZIP the files and attach them
ZIP the log file and your program configuration along with any other relevant files and attach them to your report. You can find the log file and your program configuration in your Local Application Data directory.
On Windows XP the files are here: C:\Documents and Settings\Username\Local Settings\Application Data\Doom Builder
On Windows Vista the files are here: C:\Users\Username\AppData\Local\Doom Builder

7) Do NOT report bugs for Doom Builder 1.*
It is deprecated.

8) Do NOT report bugs when you use other plugins or configurations that did not come with Doom Builder
I don't have time figuring out if the problem is really with Doom Builder or caused by the third party crap.

-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Bug reports are moved to the Closed Bug Reports forum when there is no need for them anymore. This could be because the bug is fixed, but it also happens for incorrect bug reports. When a bug is not fixed yet, I will keep it open here so that I won't forget. So if your bug report is no longer in this forum, you can find it in the Closed Bugs forum along with the reason why it is closed.


Mon Jan 05, 2009 4:21 pm
Profile
Display posts from previous:  Sort by  
Post new topic Reply to topic  [ 1 post ] 


Who is online

Users browsing this forum: No registered users and 1 guest


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group. Designed by Vjacheslav Trushkin for Free Forums/DivisionCore.