filing-bugs.md

+---
+title: How to file a good bug report
+---
+To report a bug or suggest a new feature, use the issue tracker here:
+
+https://git.allthefallen.moe/voidsquad/ttuac/-/issues
+
+# Step one: Picking the right scope.
+
+I would rather have lots of small, specific bug reports and suggestions than a few large ones. Small issues, I can fix when I have a few minutes to spare, close the issue, and feel a sense of achievement. Large ones are daunting and probably never get worked on.
+
+* **Bad issue, too vague:** Toddlers say unrealistic things.
+  * **Good issue, specific:** If you punch a toddler in the face, they say "Kindly stop assaulting my person, good sir!" but it would be more realistic if they said "Ow! Stop it!".
+* **Bad issue, too vague:** Some more watersports would be nice. :wink: 
+  * **Good issue, specific:** If the player is in the pool with five or more NPCs, there should be an opportunity to play water polo.
+
+Avoid issues which are like "shopping lists" of changes you want. I mostly ignore them.
+
+# Step two: Check for duplicates.
+
+At the time of writing this wiki page there are over 950 open issues. Many of these are duplicates. Before creating an issue, make sure there isn't a similar one already open. Search at the top for existing issues related to your problem or suggestion.
+
+**Tip: For a bug related to anal sex, search for "anal" but also related terms like "ass".**
+
+Hopefully you'll find an existing issue and then you won't need to file a new one!
+
+If you do find an existing issue that matches a problem you're having, or is similar to a suggestion you were going to make, then read the existing issue and comment at the bottom if you have any information that would be helpful.
+
+# Step three: Including helpful information.
+
+For bugs in particular, it's useful if I am able to re-enact the issue on my development machine so I can read the logs while it happens. And then re-enact it again after I think I've fixed it to check the fix works.
+
+So it's usually useful for me to have access to a saved game that illustrates the problem, preferably saved *just before the issue occurs*. If you save the game to the server, you will see a "server id" code (in magenta text beside the save). Include that in the bug report and then don't save over the game until it's fixed!
+
+Otherwise step-by-step instructions on how to trigger the bug are useful.
+
+It's also useful to explain what you expected to happen versus what actually happened, so it's clear what the bug is!
\ No newline at end of file