Garry's Mod

Garry's Mod

Tool Trees
 This topic has been pinned, so it's probably important
dim sum un  [developer] 18 Jan @ 7:42pm
Bug Reports
Describe the bug that you are facing. You can use screenshots to help visualize the problem. Then list the steps to reproduce the bug. The more detail you put in the steps to reproduce the bug, the better for me to be able to fix and improve this tool.

Bugs are tracked in the issue tracker[github.com], with the red "bug" label.

To make it a little easier for me to help with identifying bugs, here's an example of a bug report (with parenthesis to explain each aspect of the bug report). Note that everything under the "Example Bug Report" header is from an example user reporting this bug:

Example Bug Report
I'm experiencing a bug when I use this tool on "MODEL_PATH" (copy the model name from the spawnmenu) from "ADDON_NAME" (put an addon link here so a widget shows up), when I'm in the map "MAP_NAME" (most maps here in general shouldn't affect puppeteering unless they perform some prop replacement). It happens when I'm using "FEATURE_NAME" (or a sequence of different features). Here's the error message (I surround the error message with the code markup tag, so it formats nicely. See how to format the error message with the code markup).
[Ragdoll Puppeteer] lua/weapons/gmod_tool/stools/ragdollpuppeteer.lua:123: error message 1. Some 2. Function 3. Traceback
Here's the list of steps to reproduce the error:
  1. This
  2. will
  3. reproduce
  4. the error.
There's some additional details related to the bug or feature that I'm trying to accomplish with the tool (which you should explain thoroughly!). I've looked through my addons and it may have to do with addon A, or a combination of addon A, addon B, and addon C.

Takeaway
Of course, the above example bug report is subject to change if it's missing some key bug reporting detail. You are not constrained to this example; just treat it as a guideline for how you format your bug report.

In the end, I'll have trouble with fixing the bugs with this tool if you do not provide enough detail in your bug report. Let's try to work together so we can improve this tool.
Last edited by dim sum un; 18 Jan @ 7:44pm