GMS:Report A Bug

From XMS Wiki
Jump to navigationJump to search
Example of the Report Bug dialog.

While Aquaveo and its developers work hard to keep problems in GMS to a minimum, some bugs or defects may occasionally surface. Reporting bugs helps Aquaveo and its developers resolve these issues. GMS must be connected to the internet in order to report a bug.

Some bugs in GMS are reported automatically to Aquaveo. This is done through bug trap software included in GMS. Automatic bug reports typically happen whenever GMS crashes.

Bugs can also be reported by users. It is advisable to first check Bugfixes GMS and the Aquaveo's Support Forums to see if the bug has already been reported. To report a new bug, go to the Help menu and select the Report Bug command. Activating this command will bring up the Report Bug dialog.

Report Bug Dialog

When reporting a bug, complete as many of the sections of the Report Bug dialog as possible. The more information the developers have the more likely the situation can be resolved in a timely manner.

  • System Information
GMS will deliver a text file that gives the configuration of GMS on the computer where the bug was reported. Clicking on the View button will bring up this text file which shows what information is being sent.
  • What I did
Write in this section a brief description of the actions that were being done when the bug occurred.
  • What the result was
In this section, briefly explain the evidence of the bug in GMS.
  • What the expected result was
It is best to not assume that the developers will understand what should have appeared instead of the bug. Briefly state what should have occurred had the bug not occurred.
  • Email address
Provide an email address so that Aquaveo can follow up on the reported bug. Emails in bug reports are kept private and are not sold or used in marketing.
  • Project files
It can be helpful to include project files of the project being worked on when the bug occurred. This will help determine if the bug is related to GMS or if it is a problem with the project files. Include all files in a single ZIP file. Use the browser button to attach the ZIP file to the bug report.

After completing this dialog, pressing OK will send the information to Aquaveo, LLC. An internet connection must be available and active for this information to be received.

After Submitting a Bug

After a bug has been submitted, Aquaveo will review the reported bug. Whenever possible, the bug will be resolved as quickly as possible. There is no time frame for when a bug will be resolved—some are resolved within hours while others may not be resolved for many months.

In some cases, a bug cannot be resolved by Aquaveo, this is particularly true in cases where the bug has been caused by user error or if the bug is caused by third-party software used by GMS.

Not all users will be contacted once a bug is resolved. It is recommended to contact Aquaveo's technical support if there are further concerns.