Difference between revisions of "ReportingBugs"

Revision as of 08:53, 9 May 2006

Needed information

What version of the game are you running?
Have you built (from sources) the game by yourself? gcc/g++ version? SDL library versions?
What operating system are you using? What version/release of that operating system?
Can you reproduce the problem? If you can please provide steps to do it.

On special request another note: Use common sense! If you know the information can't be relevant to your report simply omit it.

Guidelines for reporting bugs

First, please make sure the bug you are reporting has not already been fixed (consult http://changelog.wesnoth.org/ to see the history of changes to the game).
If it hasn't been fixed yet, please check that the bug hasn't already been reported, by [bugs.wesnoth.org].

An account at Gna! is free and takes very little time to set up. You can submit anonymous bug reports, but then you will have to keep an eye on the bug report in case developers ask for clarification, which will delay your bug being fixed. If you login, you will receive notifications of any changes to your bug reports, which speeds things up considerably.

In-play problems

If it is in-play problem that you can reproduce, save the game and send the savegame to us with details how to reproduce the problem from the savegame.

Problems with scenarios

If it is a problem with a contributed scenario (like the ones on the Campaign Server), please report the problem to the maintainer of the scenario, not as a bug in Wesnoth itself. Bugs in the MainlineScenarios should be reported in the bug tracker.

Multiplayer out-of-sync errors

We need wesnoth stdout/stderr output from person who got the error (if you started wesnoth in terminal stdout/stderr is in that terminal).
We need savegame from person who got the error.
Savegame from some other player if possible.
The person who got the error should report the bug, other players can then add their savegames to that bug.

Segfault

In Unix follow the instructions at DebuggingWesnoth to generate information to send to a developer.
In NT based OS's (including Win2k, XP) you enable/configure core dumps by running 'drwtsn32', the location of the dumps can be changed there.
In Mac OS X, you can enable Crash Reporter -- the output is a backtrace. Run Applications -> Utilities -> Console to see log output. See http://www.mozilla.org/mailnews/osxinfo.html for information on how to enable Crash Reporter.

Sending savegames, screenshots, coredumps, etc

Please compress the files (bzip2, gzip, zip).
You can attach files if you submit your bug through Gna!, else
Put them on some web or ftp server where we can download them.
You can attach files to forum posts.
As a last resort you can send them via email to: [1]

Bug protocol

When adding a new bug, please choose either "Bug" or "Feature Request" as its Category; it may not be noticed if you leave the Category as "None".
We use the Status values "None" (awaiting action), "Fixed", "Won't Fix", "Invalid" (not a bug), "Works For Me" (unreproducible), or "Need Info".
A bug which is fixed is marked "Fixed" by a developer, probably the one committing the fix or reviewing it.
A bug present in a release is marked "Closed" only upon a new release containing the fix.
Any bug present only in WesnothSVN is marked "Closed" when it is fixed.

@@ Line 11: / Line 11: @@
 # First, please make sure the bug you are reporting has not already been fixed (consult http://changelog.wesnoth.org/ to see the history of changes to the game).
 # If it hasn't been fixed yet, please check that the bug hasn't already been reported, by [bugs.wesnoth.org].
-# If your bug or feature request hasn't been fixed and has not yet been submitted, please go ahead and report it.
-# Please post only one bug per bug report. If you have multiple bugs that are related, you can cross reference them.
-Note that feature requests should usually be discussed on the forums first, or they will generally be ignored until there is evidence that such a feature would be generally liked.
-Keep bug reports to the point, and make sure your bug is easily reproducible given the information you provide.  Clearly written, reproducible single bug reports will get attention before those reports that mix several different bugs into one report, or that are incomprehensible.
-If there is already an existing bug report, do not hesitate to add a comment with your details - this way we know when some bug is getting "popular".
-''Please login to Gna! before reporting bugs''
 An account at Gna! is free and takes very little time to set up. You can submit anonymous bug reports, but then you will have to keep an eye on the bug report in case developers ask for clarification, which will delay your bug being fixed.  If you login, you will receive notifications of any changes to your bug reports, which speeds things up considerably.