Difference between revisions of "ReportingBugs"

Latest revision as of 20:44, 26 August 2021

Where to report bugs

The preferred way to report bugs is through our bug tracking system on Github, but you can also post your problem to the forums.

Note, however, that simple typos and story/flavor text errors should be reported on the SpellingMistakes wiki page.

Note also, that bugs of user made content should be reported on the forum in the appropriate thread of the add-on in question. Usually those threads are in either the Scenario & Campaign Development, Faction & Era Development or Multiplayer Development sub forum.

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. Nevertheless too much information usually doesn't hurt.

If you have push access, please remember to add the bug or enhancement label as well as at least one applicable purple label.

How to be ignored

Your bug report is more likely to be tagged Invalid and ignored if you:

File it as anonymous so we can't ask you followup questions
Provide only the vaguest description of the problem
Don't include a savefile and a recipe for reproducing it from the savefile
Post feature requests without prior discussion at the forum or IRC

If you crave being ignored, do these things. If you want your bug addressed quickly and effectively, don't do any of them.

Guidelines for suggesting features

First, please make sure the feature you are suggesting does not already exist (particularly in the latest development version of the game, consult the changelog) by double-checking the help files and options to make sure you aren't missing something.
If it hasn't been implemented, please check that it hasn't been already submitted, by searching http://bugs.wesnoth.org.
If your feature request hasn't been submitted, start a topic about your feature at the Forums after reading "MUST-READ About the Ideas Forum".
If you get positive results on the forum (preferably from at least one developer) you can go ahead and submit your feature request using the issues tab on Github.
Please post only one feature per feature request. If you have multiple feature ideas that are related, you can cross reference them easily with "bug #123".
Be as specific as possible on how the feature should work so that anyone trying to implement it knows exactly what to do.

Guidelines for reporting bugs

When reporting simple spelling mistakes use the SpellingMistakes page.

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 http://bugs.wesnoth.org.
If your bug hasn't been reported, 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 easily with "bug #1234", where 1234 is the number of the previous bug report.

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".

An account at Github is free and takes very little time to set up.

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.

Missing music or images

If you've installed Wesnoth from the Debian/Ubuntu packages, check that you've installed the full wesnoth, wesnoth-1.14 or wesnoth-1.16 package. The same applies to any other packaging system that allows installing a subset of the components.

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). Do not compress images or sounds, unless you're posting several in a batch. In particular, don't compress screenshots.
You can attach files if you submit your bug through Github by dragging and dropping the file onto the comment box.
You can attach files to forum posts.

@@ Line 1: / Line 1: @@
-== Guidelines for reporting bugs ==
+== Where to report bugs ==
+The preferred way to report bugs is through our bug tracking system on Github, but you can also post your problem to the forums.
+* [https://github.com/wesnoth/wesnoth/issues/ Wesnoth bugs page on Github]
+* [http://www.wesnoth.org/forum/viewforum.php?f=4 Wesnoth forum - Technical Support]
+Note, however, that simple typos and story/flavor text errors should be reported on the [[SpellingMistakes]] wiki page.
+Note also, that bugs of user made content should be reported on the forum in the appropriate thread of the add-on in question. Usually those threads are in either the [http://www.wesnoth.org/forum/viewforum.php?f=8 Scenario & Campaign Development], [http://www.wesnoth.org/forum/viewforum.php?f=19 Faction & Era Development] or [http://www.wesnoth.org/forum/viewforum.php?f=15 Multiplayer Development] sub forum.
+== 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. Nevertheless too much information usually doesn't hurt.
+* If you have push access, please remember to add the bug or enhancement label as well as at least one applicable purple label.
+== How to be ignored ==
+Your bug report is more likely to be tagged Invalid and ignored if you:
+* File it as anonymous so we can't ask you followup questions
+* Provide only the vaguest description of the problem
+* Don't include a savefile and a recipe for reproducing it from the savefile
+* Post feature requests without prior discussion at the forum or IRC
-* 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 you crave being ignored, do these things.  If you want your bug addressed quickly and effectively, don't do any of them.
-* If it hasn't been fixed yet, please check that the bug hasn't already been reported, by [href="https://savannah.nongnu.org/bugs/?func=search&group=wesnoth searching the bugs database].
-* 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
+== Guidelines for suggesting features ==
-forums first, or they will generally be ignored until there
+# First, please make sure the feature you are suggesting does not already exist (particularly in the latest development version of the game, consult the [http://changelog.wesnoth.org changelog]) by double-checking the help files and options to make sure you aren't missing something.
-is evidence that such a feature would be generally liked.
+# If it hasn't been implemented, please check that it hasn't been already submitted, by searching [http://bugs.wesnoth.org http://bugs.wesnoth.org].
+# If your feature request hasn't been submitted, start a topic about your feature at the [http://www.wesnoth.org/forum/ Forums] after reading [https://forums.wesnoth.org/viewtopic.php?f=12&t=34904#p505264 "MUST-READ About the Ideas Forum"].
+# If you get positive results on the forum (preferably from at least one developer) you can go ahead and submit your feature request using the [https://github.com/wesnoth/wesnoth/issues issues] tab on Github.
+# Please post only one feature per feature request. If you have multiple feature ideas that are related, you can cross reference them easily with "bug #123".
+# Be as specific as possible on how the feature should work so that anyone trying to implement it knows exactly what to do.
-Keep bug reports to the point, and make sure your bug is easily
+== Guidelines for reporting bugs ==
-reproducible given the information you provide.
+When reporting simple spelling mistakes use the [[SpellingMistakes]] page.
-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
+# 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).
-to add a comment with your details - this way we know when
+# If it hasn't been fixed yet, please check that the bug hasn't already been reported, by [http://bugs.wesnoth.org http://bugs.wesnoth.org].
-some bug is getting "popular".
+# If your bug hasn't been reported, 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 easily with "bug #1234", where 1234 is the number of the previous bug report.
-== Please == login to Savannah before reporting bugs.  An account
+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.
-at Savannah 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.
-Bugs can be reported on (first one preferred):
+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".
-* Wesnoth bugs page on Savannah - http://savannah.nongnu.org/bugs/?group=wesnoth
-* Shortcut to previous - http://bugs.wesnoth.org/
-* Wesnoth Web Forum - http://www.wesnoth.org/forum/viewforum.php?f=4
-* Shortcut to previous - http://forum.wesnoth.org/
-Needed information:
+An account at Github is free and takes very little time to set up.
-* 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.
-In-play problems:
+=== In-play problems ===
-* If it is in-play problem that you can reproduce:
+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.
-  save the game, send the savegame to us with details how to reproduce
-  the problem from the savegame.
-Problems with scenarios:
+=== Missing music or images ===
-* If it is a problem with a contributed scenario (like the ones on the
+If you've installed Wesnoth from the Debian/Ubuntu packages, check that you've installed the full '''wesnoth''', '''wesnoth-1.14''' or '''wesnoth-1.16''' package. The same applies to any other packaging system that allows installing a subset of the components.
-  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:
+=== Multiplayer out-of-sync errors ===
-* We need wesnoth stdout/stderr output from person who got the error
+* We need wesnoth stdout/stderr output from person who got the error (if you started wesnoth in terminal stdout/stderr is in that terminal).
-  (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,
+* The person who got the error should report the bug, other players can then add their savegames to that bug.
-  other players can then add their savegames to that bug.
-Segfault:
+=== Segfault ===
-* In Unix you enable core dumps with running 'ulimit -c unlimited'
+* In Unix follow the instructions at [[DebuggingWesnoth]] to generate information to send to a developer.
-  on console and then starting wesnoth from that same
+* 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.
-  console, core dumps will go to current working directory ('pwd')
+* 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.
-* Send us backtrace output of the core file
-  (using 'gdb /path/to/binary /path/to/corefile', and inside gdb 'bt')
-* 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 [[MacOS]] 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:
+=== Sending savegames, screenshots, coredumps, etc ===
-* Please compress the files (bzip2, gzip, zip).
+* Please compress the files (bzip2, gzip, zip). Do not compress images or sounds, unless you're posting several in a batch. In particular, don't compress screenshots.
-* You can attach files if you submit your bug thru Savannah (512KB max size), else
+* You can attach files if you submit your bug through Github by dragging and dropping the file onto the comment box.
-* 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: davidnwhiteA[[TcomcastDOTnet]]
-== Bug protocol ==
-* When adding a new bug, please choose either "Bug" or "Feature Request"
+[[Category:Troubleshooting and Bugs]]
-  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 [[WesnothCVS]] is marked "Closed" when it is fixed.