The best ways to report bugs

The best ways to report bugs

Discuss your problems with the latest release of the engine here. Problems with games, maps or other utilities belong in their respective forums.

Moderator: Moderators

Post Reply
User avatar
AF
AI Developer
Posts: 20687
Joined: 14 Sep 2004, 11:32

The best ways to report bugs

Post by AF »

Whats the best way of getting a bug fixed?

Hoping itll get fixed in the next release(worst)
Chances: 0-2%
If the developers dont know about it they cant fix it

Start a thread complaining about crashes
Chances: 5-10%
Not enough information

Tell a developer via IRC/MSN/Lobby
Chances: 10-15%
They're unlikely to remember the bug, developers are in short supply and as a result are very busy.

Start a thread with stacktraces and a detailed description in Help &Bugs
Chances: 20-40%
Depending on how much data is given. The key difference here is the stacktrace

Report a bug in Mantis/BugTracker(official method)
Chances: 75-100%
A stacktrace attached to a mantis bug report with a detailed description will go a long way to getting that bug fixed, the added organisation of the bugtracker helps the developers enourmously http://spring.clan-sy.com/mantis

Supplying an SVN patch fixing the bug(best method)
Chances: 95-100%
Unless your patch is bad this is the best way to get rid of bugs if you have programming knowledge


How can I boost my chances further?

Supplying a translated stacktrace
Chances: +40%
A developer is going to have to take the effort to translate a stacktrace into human readable form, only then will a stacktrace be useful, giving the exact line number in the code the bug occured at. Save time and let develoeprs instantly see where they went wrong http://www.osrts.info/~buildbot/spring/ ... slator.php

Supply detailed information about the circumstances around the bug and if possible steps to reproduce it
Chances: +60%
Sometimes a stacktrace isnt enough, and some bugs can eb ahrd to track down. If you can clearly describe howto reproduce a bug then it greatly increases a develoeprs ability to fix it.

Supply information about your system
Chances: +30%
Sometimes a bug only occurs for a few people. Providing information such as how much ram you have, what graphics card you're using, or your Operating system and service packs can help enourmously. Sometimes running certain programs could interfere with spring so list any programs open at the time of the crash.

Where AIs or lua widgets running?
Chances: +10-50%
Sometimes a crash is not springs fault, but an AI or lua widgets fault. Providing a list of AIs or active GUI widgets could reveal the cause of the bug. If it is an AI or widget bug then you could get a bugfix very quickly without waitign for a new release of spring

Screenshots
Chances: +10-70%
Sometimes a bug can be hard to explain and developers can read things wrong, whereas a picture speaks a thousand words.

Being nice
Chances: +20%
Developers are in short supply which means they can be very busy. If they're not fixing bugs theyre adding features. Your not going to pursuade them to spend time on gixing your bug if your hurling insults.

Choose a method and stick with it
Chances: +10%
Reporting a bug in every single method possible wont maximize its chances of being fixed, your just going to annoy people. Report a bug using the best method appropriate and stick with it, keep upto date on progress.
Last edited by AF on 17 Aug 2007, 20:25, edited 1 time in total.
imbaczek
Posts: 3629
Joined: 22 Aug 2006, 16:19

Post by imbaczek »

modded as +1, Spread the word

PS obligatory link to Mantis: http://spring.clan-sy.com/mantis
Last edited by imbaczek on 17 Aug 2007, 16:49, edited 1 time in total.
trepan
Former Engine Dev
Posts: 1200
Joined: 17 Nov 2005, 00:52

Post by trepan »

A translated stacktrace will serve you even better (windows):
http://www.osrts.info/~buildbot/spring/ ... slator.php
User avatar
SwiftSpear
Classic Community Lead
Posts: 7287
Joined: 12 Aug 2005, 09:29

Post by SwiftSpear »

I wish I could merge this into the "how to report bugs" sticky...

Massively awesome thread...
Tobi
Spring Developer
Posts: 4598
Joined: 01 Jun 2005, 11:36

Post by Tobi »

Clearly explaining a way to reproduce the bug 100% reliably gives a +60% chance bonus.
User avatar
AF
AI Developer
Posts: 20687
Joined: 14 Sep 2004, 11:32

Post by AF »

edited and updated, added links, added new section
Post Reply

Return to “Help & Bugs”