Hey there. If you're here, that means you want to report a bug in a mod! Well, you're in the right place. Before we get started, though, let's look at some important things (click on any to see why it's important):
Are you in the latest version of the mod?
Reporting bugs in old versions of mods is a bad idea, these bugs might have been fixed in newer versions of the mod and you might just be wasting the modder's time. If you're using a modpack, try updating the mod manually, and if it works, ask the modpack's creator(s) to update the mod.
Are you in the latest version of Forge?
Having the latest version of Forge is crucial to pointing out bugs. If you can reproduce an issue with an old version of Forge, but not with the latest version then it works fine. Old versions of Forge should not be supported, as the new ones, more often than not, contain major bugfixes.
Are you using vanilla Forge (not MCPC+)?
MCPC+ is a bridge between Spigot (a fork of Bukkit, providing better optimization and some other features) and MinecraftForge. In sum, it allows you to use Bukkit Plugins and Forge Mods in the same server.
Due to the ways it uses to create this bridge, it's to expect some mods to be incompatible with it. Mods are not meant to be built for MCPC+ by default, if some functionality is not working with MCPC+ installed but works fine without it, report the issue to the MCPC+ team instead.
Are you using Optifine?
Optifine, as implied by it's function, changes the basic way things are drawn on the screen. Some mods depend on complex rendering sequences to get the desired visual effect for their blocks/items/entities/whatever. If something looks out of place with optifine installed, try it without optifine and see if it looks right, and if it does, the issue has to do with the interaction between the mod and optifine.
As Optifine is a closed source mod, workarounds are not possible without technically violating the license. That's the main reason why most mods do not support optifine.
After you've checked all of these out and are confident the issue doesn't lie in any of the problems above stated, by all means, carry on!
Start by briefly describing what the issue is, try to be as concise as possible. Make sure you highlight details, any cross mod interactions should be explained, the more you leave out, the harder it is to find the issue and fix it.
If you're struggling to put an explanation of the issue in words, take a screenshot or a video. Minecraft has screenshots built in with the F2 key. After you took a screenshot, upload it to imgur
or any other image hosting website.
Bad: i tried to create the blocky thingymajig and my game crashed help please
Good: I was trying to create the Blocky Thingymajig, I gathered all the crafting components, when I pulled the item out of a Super Crafting Table from the SuperCrafting mod, my game crashed.
Make sure to include the FML log, regardless of your game having crashed or not. The log contains all sorts of important information such as which mods are loaded, alongside which versions. Make sure to check out the following points (click on them for more info):
How do I get the log?
Start off by going to your .minecraft folder, as you normally do to install a mod. You should have a "logs" folder. Inside it, look for "fml-client-1.log", open it with Notepad or your text editor of choice (Notepad++ is pretty good!) and there you go, there's the log.
Where do I put the log?
paste the log next to the report, doing so causes an incredible amount of clutter and is really hard to look at. Instead of that, put the log in a paste hosting website and attach a link to it, here's a few examples:
pastebin hastebin gist pastie puush
Review your issue. Make sure it's well structured, try to look at it from the point of view from someone who is trying to follow the steps you give them to reproduce what happened.
If the modder can't read what you did and reproduce the issue themselves, more likely than not, you left a step out. Try to follow it yourself and see if you can have it happen again with the information you gave only.
My game crashes when I try to create a Blocky Thingymajig from your mod using a Super Crafting Table from the SuperCrafting mod. I can get it to happen every time by simply placing the materials in the table and pulling the Blocky Thingymajig out (both via shift-click and just a normal click).
This does not happen with any other item from any other mod (at least from the ones I've tried). The crafting works fine with a normal vanilla Crafting Table.
FML Log: http://puu.sh/8BDKc.log
Your issue is done, time to report it. The best place to do it varies from mod to mod. The best places to do it generally are on the mod's issue tracker (if one exists) or the mod's forum thread. Do not report a bug over IRC, Twitter or private messaging of any way, this makes your issue easy to forget, or disallow other people than the modder to help you with it.
The best way to do it is to look for "issue tracker" or "github repo" on the mod's thread or website. That is the preferred way for most modders to track their issues (duh), as it lets them label the issue, edit it case something needs to be set, and of course, have all the issues categorized in a specific area.
Before you pull the trigger and submit the issue, though, make sure nobody else reported it. Look around in the last few pages of the thread, or the issues page in the issue tracker, if somebody already reported the issue, reporting it again is a simple waste of time, both for you and for the modder. If you're looking on the issue tracker, make sure to check the both the open and closed issues, as the issue might have been fixed already.
And there you go, you have successfully reported your issue!
If you're interested on learning more about bug reporting, Simon Tatham wrote an essay
about that very matter, if you're committed to be an awesome bug reporter, it's definitely worth a read.
Tweet about this!