How to make a successful bug report

If you want to contribute to fix the issues of Dangerous Rays this place is for you
Post Reply
rezur
Technical Community Manager
Technical Community Manager
Posts: 16
Joined: Thu Apr 17, 2014 6:41 am

How to make a successful bug report

Post by rezur » Sat Apr 26, 2014 2:20 pm

Here's a short tutorial on how to make a successful bug report.

First of all try to replicate the bug. Find out the conditions if any that need to be fulfilled to create the bug. For example walking to the back of a tent, lighting a fire in a house, dropping an item while pressing ALT key, etc ...

Now it's time to go to http://www.dangerousrays.com/bugtracker/ and register on it if not already done. Registration is useful so we can answer specific people or reporters to ask for more details on bugs. It takes only 30 sec to register so go ahead and create an account.

When your account is done, you'll see a menu on the top of the page. Follow the points below to make a successful report.

NB : All reports have to be done in ENGLISH only.

1. Click on "View Issues" and then search for a similar bug using the Search text box. Adding a new report on an existing bug is just a waste of time both for you and the team, so make sure the bug you're reporting doesn't exist on the plateform yet.

2. If you didn't find your bug then it's time to click on the "Report Issue" from the top menu.

3. Report Issue Form :
- From the "Category" combo box select which one describes your bug the most
- Select the right option in "Reproducibility" combo. Leave Severity and Priority as they are, they'll be filled by the team.
- Leave the profile infos as it is.
- Enter the "Summary", which is the title of your bug. Be precise and explicit. Don't say "It crashes !!!!" but say "When I click the Save button it crashes"
- Same goes for the "Description".
- The "Steps to reproduce" text box is particularly important for us to understand the problem. You need to explain what you did exactly to make the bug occurs, you can even post a screenshot of the bug or error message if that will help us reproducing it (if for example the bug only occurs on specific locations on the map).
- You can use the "Upload File" to upload any screenshot or crash dump you deem necessary for your bug report. Be careful, file size cannot exceed 5Mb, so don't forget to convert your screenshot to jpg or png file. You need to upload the "debug.log" file you'll find in the game installation directory. That's essential for us, so please don't forget ! You can compress (zip, rar) the file if it's too big to upload.
4. Click "Submit Report" button and you are done.

What happens next ?
The team will receive an email with your bug report, then will try to reproduce the problem. The bug will be assigned to a developer (for now it's only OldSnake), he will be able to add notes to your bug to ask questions about how it occurred for example or if he needs more info on the bug.

The team will add a priority for your bug, and will start working on it. You'll receive updates of your issue by email as soon as an update is done on it.

That's it ! Easy right ?

Dangerous Rays is in alpha, and good bug reports is what will make this game successful, so we need your help !

Thank you very much for your help and support.
How to write a good bug report : viewtopic.php?f=17&t=82

User avatar
aggelon
Posts: 13
Joined: Wed Apr 09, 2014 9:04 pm

Re: How to make a successful bug report

Post by aggelon » Sat Apr 26, 2014 4:44 pm

Hi rezur,

Thank you for this explanations.

Since a research is required before opening a new report, I assume all reports have to be written in english language... although it seems obvious, I'm not sure everyone got it in mind, so it may be better to specify it
(report #8 could provide bad ideas #-o )

See you.

rezur
Technical Community Manager
Technical Community Manager
Posts: 16
Joined: Thu Apr 17, 2014 6:41 am

Re: How to make a successful bug report

Post by rezur » Sat Apr 26, 2014 5:10 pm

Post edited, thanks for the suggestion.
How to write a good bug report : viewtopic.php?f=17&t=82

Post Reply