Reporting Bugs

In any software application, there are bound to be bugs and other unanticipated issues that arise through extensive use. To deal with these issues, software engineers typically employ methods such as "alpha" and "beta" releases, which are limited releases of code or binaries to the public, with the idea that the users themselves can discover problems through use, as well as offering critical feedback on various features.

If you have encountered a bug or an issue, we would love to hear about it. However, it may be possible that the bug has already been reported, that a workaround might exist, or even that it has already been addressed. Thus the best plan of action is:

  1. Check for an existing report by searching here:
  2. If no report exists, click "Report a Bug" on the same page and follow the instructions

To better organize bug reports, and avoid confusion, we recommend using the following scheme in your report, which is based on the Sun Microsystem website (see this site for examples):

A line which concisely presents the problem context.

Which version, series, or branch you are working with. Include the ModelGUI version and the Java version you are working with (to check the Java version, type java -version from the command prompt).

A detailed description of the problem, including class names and stack traces from any exceptions encountered. If applicable (and if you are a developer), try to design a code snippet which reproduces the bug (a test case). For graphical display issues, screenshots or movies would also be helpful.

Detail the steps required to reproduce this problem. Does it occur always or only sporadically? If sporadically, have you noticed any special conditions which may lead to the problem?

If applicable, describe any workaround you may have found for this issue.

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License