-
Notifications
You must be signed in to change notification settings - Fork 4
Writing Helpful Bug Reports
So you've heard about the Strata mod for Minecraft and you'd like to help out by reporting in game bugs? Well, this guide will cover important tips so that your bug reports will be as useful and helpful to me as possible. I'll also outline common mistakes that make bug reports not as useful as they could be and how to avoid them, with clear examples.
Search the Issues page before you report a bug! "But I don't have time to report this, I want to get back to my game!"
This is very important: to save yourself (me) time and effort, try searching the page first to see if your bug has already been reported. If you are unable to locate your bug, and it looks like it hasn't been reported already, you can come back and submit a bug report when you do have time.
Searching before creating a bug will keep the number of duplicate reports to a minimum and is the best way to help me get to your issue as soon as possible. The fewer bugs I have to go through and mark as duplicates, the faster I'll get to your bug!
Tips for Searching: When you use generic keywords, you might get lots of responses. Be as specific as possible with your keywords/descriptions to make sure you find any bugs related to your problem.
"Help! It's broken!"
When reporting a bug it is very important that you be as specific as possible. I know mentioned this previously, but I can't emphasize enough how important this is.
Try to avoid saying things like "My game is broken!" because this doesn't tell me anything other than a desperate cry. Instead, try to keep the following questions in mind:
What's broken? (e.g. "Ores are dropping helmets, not the minerals they are supposed to drop.")
What version of Minecraft are you running? (e.g. "Minecraft 1.15.2")
Even if your bug report is really well written, knowing what version of Minecraft you're running is very important as there is a chance I already have fixed the bug in another version and I need to know what version I should run when trying to recreate your bug. When you start up Minecraft, you'll be able to see what version you are using.
What version of Forge are you using? (e.g. "Forge 1.15.2 - 31.2.0")
Knowing what version of Forge you're using is very important for me to know as there is a chance I already have fixed the bug in another version and I need to know what version I should use when trying to recreate your bug.
Other useful information
The more information you can share, the better! Sharing pictures, videos and logs of the bug can very crucial for solving the problem you're experiencing. Also if you know what version of Java you are using and what operating system you are using (Windows 7, Windows 10, OSX, for example), be sure to write it down in the specified field of the bug report.
Note: For logs please use https://pastebin.com/ to link towards these logs or an alternative which is similar.
"This is broken and this is broken, and this..."
I know you're eager to get all of your bugs fixed, but if you stuff them all in one bug report, chances are they'll get lost or it will just make things more confusing. Make one bug report per bug, that way you can be as specific and detailed as possible and I can focus on one bug at a time.
Useful Link(s):
Homepage: https://github.com/Quizer9O8/Strata