Skip to content
This repository has been archived by the owner on Jan 20, 2021. It is now read-only.

Bug Reports

Jump to bottom
Phanx edited this page Oct 6, 2016 · 2 revisions

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

1. Check for a newer version of Grid.

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.

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

Please do not submit new reports about issues that already have an open ticket. Instead, check the ticket to see if you can provide any more information that the original submitter did not provide. The more information you can give us, the faster we can find and fix the bug.

However, if you do not have new information to add, please don't post a comment just to say “me too” or repeat information that someone else already posted. These types of comments just clutter up the ticket and make it harder to read.

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. If the problem only happens when a plugin is enabled, 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 does not happen with default settings, please include your saved settings file with your bug report. This file is located in World of Warcraft » WTF » Account » <YOUR ACCOUNT ID> » SavedVariables » Grid.lua

5. Install Bugger to check for Lua error messages.

If you already have BugSack, Swatter, or a similar addon installed, you can use that instead. (Prior to the Legion expansion, the game itself had an option to display Lua errors, albeit in an intrusive and limited way, but this option was removed, so an addon is required now.)

These error messages are invaluable to addon authors, since they often pinpoint exactly what the problem is, and exactly where it happens in the addon's source code.

You should only include the first error message that appears. Any additional errors are usually caused by the first error, and do not provide any further insight into the problem.

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 clutters up your report.

6. Submit a bug report:

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

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!

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
  2. WoW version, region, and language
  3. Step-by-step instructions we can follow to make the bug happen
  4. What you think should happen when you follow those steps
  5. What actually happens for you instead
  6. The exact text of the first error message that appears
  7. Saved settings file, if the bug is related to your settings (Step 4)
  8. Screenshot, if the bug is graphical

Tips:

  • Don’t use relative terms for versions like “latest” or “newest”. Use the actual version numbers!
  • If you aren’t sure what version of Grid you’re using, check the Grid.toc file in the addon’s folder.
  • If you aren’t sure what version of WoW you’re playing in, check the lower left corner of the login screen, or type /dump GetBuildInfo() in-game.

Submitting Patches:

If you’ve already fixed the bug yourself, please fork the repo on GitHub, submit your changes there, and submit a pull request. Alternatively, attach a patch file or your modified Grid file(s) to your ticket.

Clone this wiki locally