Bugs: Difference between revisions

From Spring
Jump to navigationJump to search
Knorke (talk | contribs)
added See if the bug and a solution are already known
Abma (talk | contribs)
 
(25 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== See if the bug and a solution are already known ==
== See if the bug and a solution are already known ==
You can do so in the [[FAQ]]
Check that it isn't already visible somewhere near the top of the relevant bugtracker:


You can also have a look at recent and stickied threads in the [http://springrts.com/phpbb/viewforum.php?f=11 Help & Bugs Forum]
[https://springrts.com/mantis Spring Engine bugtracker (mantis)]


== Where to report bugs==
[https://github.com/springlobby/springlobby/issues Spring Lobby (github)]
In general, the forum is a bad place to report a bug. Often ofter people will add comments, which confuse others and don't help to understand, whats the real problem. So, if you found a bug in the Spring Engine, please report it to the [http://springrts.com/mantis bug tracker].
 
[https://github.com/dansan/spring-replay-site/issues Replay Site (github)]
 
Or see the relevent project pages for links to other bug trackers. There is also a [https://springrts.com/phpbb/viewforum.php?f=11 helps and bugs forum].
 
== How to report bugs==  
To report a bug, please give a description, what is going wrong and '''how it can be reproduced'''. what steps are required to reproduce it? If required to reproduce the bug add a script or/and a link to the Game/Map.
 
==Logfiles, screenshots, replays==
* It is best to always attach [[infolog.txt]], as it contains system/driver/version info and a stacktrace if spring crashed.  
 
* Attach a replay: often Bugs can't be reproduced, its often better to see something than to only read about that.


Keep in mind, devs often don't read the forum, they've few time for it.
* Screenshots are taken with the F12 key and saved in the \screenshots\ folder. You can attach them to postings or upload on site such as: [http://www.imgur.com imgur.com] , [http://www.abload.de abload.de]


== How to report bugs==
If a dev asks you for more information, please answer his questions. Try to avoid endless discussions why a bug was introduced, be polite!


Before [http://springrts.com/mantis/bug_report_page.php filling a bug], please look if someone else [http://springrts.com/mantis/view_all_bug_page.php already has reported] this issue.
If you want more tips for a good bug-report, please read "[http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to Report Bugs Effectively]"
'''The better the bug-report, the better the chances, that it will be fixed!'''


To report a bug, please give a description, what is going wrong and how it can be reproduced. what steps are required to reproduce it?
== Where to report bugs==


Nearly always attach infolog.txt, as it contains system/driver/version info and if spring crashed, it also (should) contain an crashdump, which allows to find out, why it crashed and to fix it. If it makes sense, make a screenshot + attach it.
Bugs in individual games should be reported to the game developers - contact the game developer first if you are unsure.


infolog.txt should be found next to Spring.exe and screenshots are taken with the F12 key and saved in the \screenshots\ folder.
===As a player who needs help or thinks they found a bug===
Do not be afraid to ask for help [http://springrts.com/phpbb/viewforum.php?f=11 in the forum.] Read the guidelines above so people can help you as good as possible.


If a dev asks you for more information, please answer his questions.
===As a developer who found a bug===
The better the bug-report, the better the chances, that it is fixed!
If you found a bug in the Spring Engine, please report it to the [http://springrts.com/mantis bug tracker].
Before [http://springrts.com/mantis/bug_report_page.php filling a bug], please look if someone else [http://springrts.com/mantis/view_all_bug_page.php already has reported] this issue.


Try to avoid endless discussions why a bug was introduced, be polite!
Also please:


If you want more tips for a good bug-report, please read "[http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to Report Bugs Effectively]"
# disable LuaRules/LuaUI for testing
# debug all relevant Lua callins


Bugs should be reported for latest release version and latest develop version.


[[Category: Development]]
[[Category:Engine Dev]]

Latest revision as of 21:44, 16 October 2019

See if the bug and a solution are already known

Check that it isn't already visible somewhere near the top of the relevant bugtracker:

Spring Engine bugtracker (mantis)

Spring Lobby (github)

Replay Site (github)

Or see the relevent project pages for links to other bug trackers. There is also a helps and bugs forum.

How to report bugs

To report a bug, please give a description, what is going wrong and how it can be reproduced. what steps are required to reproduce it? If required to reproduce the bug add a script or/and a link to the Game/Map.

Logfiles, screenshots, replays

  • It is best to always attach infolog.txt, as it contains system/driver/version info and a stacktrace if spring crashed.
  • Attach a replay: often Bugs can't be reproduced, its often better to see something than to only read about that.
  • Screenshots are taken with the F12 key and saved in the \screenshots\ folder. You can attach them to postings or upload on site such as: imgur.com , abload.de

If a dev asks you for more information, please answer his questions. Try to avoid endless discussions why a bug was introduced, be polite!

If you want more tips for a good bug-report, please read "How to Report Bugs Effectively" The better the bug-report, the better the chances, that it will be fixed!

Where to report bugs

Bugs in individual games should be reported to the game developers - contact the game developer first if you are unsure.

As a player who needs help or thinks they found a bug

Do not be afraid to ask for help in the forum. Read the guidelines above so people can help you as good as possible.

As a developer who found a bug

If you found a bug in the Spring Engine, please report it to the bug tracker. Before filling a bug, please look if someone else already has reported this issue.

Also please:

  1. disable LuaRules/LuaUI for testing
  2. debug all relevant Lua callins

Bugs should be reported for latest release version and latest develop version.