Menu

Bug_reporting

Hugh Greene

All bug reports should be made on the relevant tracker. Note that
suggestions should not be put on the trackers only bug reports, please
see Suggestions for info.

Currently multiple trackers are in use for bug reporting:

Which one?

ENIGMA is made up of multiple projects managed by different people. To
make sure that your bug gets addressed quickly and not bounced around
too much, it helps to identify which project your bug affects and report
it to the correct tracker. This can be as simple as understanding the
difference between LateralGM,
ENIGMA, and the Plugin. As a
rule of thumb, LateralGM is the graphical interface, the Plugin is
anything involving the ENIGMA menu, and ENIGMA uses terminal output or
Enigma Progress Console output or the running game itself.

If you are experiencing an error or undesirable terminal output, there
are a few quick ways to differentiate:

  • An Exception can be assumed to be a plugin bug (or possibly an LGM
    bug), and typically looks like:

Unhandled exception: java.lang.NullPointerException: Blah Blah
at blah(blah:123)
at blah(blah:321)
at blah(blah:12)

  • Otherwise it can generally be assumed to be an ENIGMA problem.

To easily differentiate between an LGM and a Plugin bug, simply copy
lateralgm.jar to a location by itself (without ENIGMA), start it in that
new location, and try to reproduce the bug. If you can, it is definitely
a LateralGM bug.

If you can't decide, feel free to ask on the forums or IRC. You could
post your bug report on any tracker, but if it's placed on the wrong
tracker, the devs will have to take some extra steps to close your bug
and repost it on the correct tracker.

Reporting correctly

If you have received an error of any kind then please copy and post the
entire terminal output, pastebin can be used to
paste any text if it is long. Other things that are also always helpful
to post are: the platform you are using, the enigma revision you are
using (if you know it) and a description of the issue so it is actually
understandable. Before posting please preferably try and look to see if
the bug has already been posted previously. Also note some things should
not be posted on the trackers such as missing functions or variables
since ENIGMA is still in development these obviously just haven't been
written yet, suggestions should also not be posted on the trackers these
should be made on the wiki in the relevant
place
.

It may also be handy for you to check the tracker again after a while to
see if a developer is requiring any further information about what the
bug is. If you think the bug may require a lot of discussion or in most
cases if you want the bug to be solved faster it is also advisable that
you go onto the IRC and mention the bug you have
reported.


Related

Wiki: Bug_reports
Wiki: Bugs
Wiki: ENIGMA:Guide_on_GitHub_issues
Wiki: ENIGMA
Wiki: Help
Wiki: IRC
Wiki: LateralGM
Wiki: Plugin
Wiki: Suggestions
Wiki: Ticket_procedure

MongoDB Logo MongoDB