Skip to content

Reporting Issues

EmilyBjoerk edited this page Oct 14, 2013 · 5 revisions

Please follow the below procedure when reporting issues to make fixing the issue as quick as possible.

  1. Update to the latest version available from the download page and verify that the issue persists.
  2. Check that the gamedir entry in the file C:\Users\%USERNAME%\AppData\Roaming\lsml_settings.xml points to the correct game install. The file might be located elsewhere on Windows XP, please use search to locate it. If it doesn't point to an up-to-date install please change it to point to the correct install or remove the file (this will revert your settings to defaults) and see if the issue persists.
  3. Go to the lsml github page and search the issue database to see if the issue is already reported (in which case you can comment on it to indicate it is affecting more users). Please use the search bar at the top where it says This repository it will search among the issues in the database too.
  4. If none of the above steps resolved your issue and you didn't find the issue in the database, please fill in this template:
LSML version: x.y.z

A lsml:// link to any build that is related to the issue.

Steps to reproduce:
1. open lsml
2. ...
3. ...

Actual result:

Expected result:

and verify that the steps to reproduce actually provokes the issue by closing LSML and following the steps exactly and that you see your actual result. Then submit a new issue with the filled in template.

Q: Why do I have to provide all this?

A: Every one thinks in different ways, what is obvious to you might not be obvious to me. Therefore it is necessary to have precise steps to reproduce, please don't leave any steps out. The steps also allow us some insight into what might be the problem just by looking at the issue report and allows us to do a preliminary time assessment. The actual result allows us to verify that we have indeed reproduced the bug. The expected result allows us to know if the issue is a bug in the code or a needed improvement which affects priority.