Grid

How to report a bug in Grid

r5

Following these instructions will ensure that your bug report is useful, and that we can find and fix the problem quickly!

1. Check the FAQ and list of known issues.

The Frequently Asked Questions list answers some common questions about Grid, and the list of known issues lists issues that are already known and do not need to be reported again, as well as issues that are commonly reported as bugs, but are not actually bugs (or at least, are not bugs in Grid).

2. Check for a newer version of Grid.

Bugs in old versions of Grid may have already been fixed. Please make sure you are using the latest release version before reporting a bug. If it’s been a while since the last release, you might also try a beta version.

3. Disable all other addons, including Grid plugins.

Many issues reported to us are actually caused by outdated plugins. While plugins do interact with Grid, they are separate addons written and maintainted by separate authors, and the Grid team cannot provide any support for them. Contact the plugin’s author instead.

4. Switch to a new profile in Grid with default settings, and then reload your UI.

If you’ve been using Grid for a long time, you may have settings saved in your profile that aren’t used by current versions of Grid, or your saved settings may have gotten corrupted. Switching to a new profile with default settings is a quick and easy way to find out if something in your settings is triggering the bug. If the problem doesn’t still happen with default settings, please include your saved settings with your bug report.

5. Try clearing your game cache.

WoW isn't very good at managing its cache, and files in there tend to get corrupted. A corrupted game cache can cause any problem you can imagine, and then some. Clearing the cache won't hurt anything -- WoW will just make a new one -- and just takes a minute. Log out of WoW, and completely exit the game. Then go into your WoW program folder, and delete the whole Cache folder. Now start WoW again and log back in.

6. Install BugSack to check for Lua error messages.

The game’s built-in error display cannot detect errors that occur while the UI is still loading; BugSack can. The game’s built-in error display forces you to copy the error message immediately, or keep it on your screen, or lose it; BugSack stores error messages so you can copy them later when it’s more convenient.

If you absolutely do not want to (or can’t) install BugSack, please at least enable the "Show Lua Errors" option under Interface Options > Help, and mention in your report that you don’t have BugSack so we know we still need to check for loading errors.

You should only include the first error message that appears. Most often, subsequent errors are actually caused by the first, and do not actually indicate a separate bug in Grid.

Please do not include the lists of local variables or installed addons that may be shown after the actual error message. This information is almost never useful, and just clogs up the report with a huge amount of text to scroll past.

7. Check to see if the bug was already reported.

Check the bug tracker to see if the bug was already reported. If it was, please do not submit a new ticket. Instead, check the existing ticket to see if you can provide any new information that the original submitter did not provide. The more information you can give us, the faster we can find and fix the bug.

8. What to include in your report:

The following information should be provided in any new bug report. Remember, the more information you can give us, the faster we can find and fix the bug. If you don’t give us enough information, we may not be able to find the bug at all.

  1. Grid version
    If you aren’t sure, check the "Grid.toc" file in the addon’s folder.
    Please don’t use relative terms like "latest" or "newest".

  2. WoW version
    If you aren’t sure, check the lower left corner of the login screen.
    Please don’t use relative terms like "latest" or "newest".

  3. WoW region and language

  4. Step-by-step instructions to reproduce the issue

  5. What you expect to happen, and what actually happens

  6. The exact text of the first error message that appears
    Don’t include lists of local variables or installed addons!

Depending on the type of bug, you should also include:

  1. If the bug is triggered by your settings (Step #3), please include a copy of your saved settings file, and include the exact name of the profile you are using. Attach the file to your ticket, or upload it somewhere and include the URL in your ticket.
    Your saved settings file is stored in World of Warcraft > WTF > Account > ACCOUNTNAME > SavedVariables > Grid.lua

  2. If the bug is graphical (eg. something looks wrong on the screen), please include a screenshot. Attach the image to your ticket, or upload it somewhere and include the URL in your ticket.
    Screenshots taken in WoW are stored in World of Warcraft > Screenshots

  3. If you’ve already fixed the bug yourself, including a patch file or a modified copy of the related Grid file can speed things up. Attach the file to your ticket, or upload it somewhere and include the URL in your ticket.

9. One report, one bug!

Please don’t report multiple bugs in a single ticket. If you do, it takes longer to find and fix them, because we have to spend time creating new tickets for the additional bugs, and it’s often hard to tell which information goes with which bug. If you are reporting multiple bugs, please submit multiple tickets!

10. Where to report bugs:

Report bugs in the WowAce ticket tracker. You will need to create a Curse account first, but this only takes a few seconds.

Facts

Date created
Dec 20, 2012