-
Notifications
You must be signed in to change notification settings - Fork 7
Bug Reports
I always appreciate bug reports, but in order to fix them I need to be able to reproduce them on my computer. In order to do that I need to have certain info about the bug and your current setup. Not all of these are always necessary and there are things missing from this list, but this is a good general guideline of what to include in your bug report.
- Incorrect behaviour. What is happening that shouldn't be happening? Describe what you expect should happen and how that thing isn't happening. For this it's very helpful to include one or more screenshots of what's happening.
- Your setup. What class/spec are you playing? Are you in combat, in a raid, doing an arena, etc? Are you looking at friendly or enemy units? Are they players or npcs? Are they particular units or any unit? This is a very broad category, but many bugs only occur in some very specific and unexpected circumstances.
- Current settings. What are your TidyPlates settings and CVars? Include as many relevant settings as you like, if nameplates are being shown incorrectly, specify what display conditions you are currently using. Some blizzard settings (CVars) are accessible through the blizzard UI, but many aren't. If you know that you manually changed one of those, including it is very helpful. You can also upload the full CVar and TidyPlates settings files, but that is going to be overkill 99% of the time.
- Attempts to fix. Have you done anything to fix it yourself? Played around with some settings, looked at different units, in different situations, etc. Does any of that change the behaviour of the bug?
Here's an example bug report that is excellent. It includes details about the quest that it occurred in, screenshots of the behaviour that TidyPlates causes and the default behaviour, a detailed description of what should happen and some additional info about the situation it happened in. It also doesn't include many of the points I brought up above, not everything I listed there will always be relevant. Eg the players class doesn't matter for that bug. In those cases it's no problem to just leave that part out. But if you can see the same problems on multiple classes it can still help to mention that so I know that that was already tested.