-
Notifications
You must be signed in to change notification settings - Fork 8
Bug Reporting Guidelines
Developers love bug reports. It means you found something wrong, and want to help make the mod better. That said, an incomplete or imprecise bug report can be incredibly frustrating. Here's some general guidelines to help you write clear, concise, and useful bug reports.
Please read through these before reporting a new bug on the issue tracker.
The first step in submitting a good bug report is making sure it's actually a bug with Particle Physics. This seems like a no-brainer, but there's a lot of bugs that get reported which have very little to do with Particle Physics, or have more to do with someone's particular play style. Check the following to help make sure you don't report invalid bugs:
- Can you reproduce it? A bug that can't be reproduced, can't be fixed.
- If you can reproduce it, you've got to tell me the steps to reproduce it. Knowing that there is a bug out there that I can't fix because I can't find it is really frustrating for me.
- Can it be reproduced with just Particle Physics (or Particle Physics and the relevant mods) installed?
- Frequently, mods will conflict with eachother in one way or another. Knowing specifically what mods are involved goes a long way towards helping me fix a bug.
- If you're running a modpack, please tell me which one, and what version. Saying "I'm running that one FTB modpack" doesn't help me. Saying "I'm running Resonant Rise 2.9.2.3 with no custom options" is extremely helpful.
- If you're running a custom modpack with more than three or four mods, you must identify which mods are causing the issue. If you don't identify the cause, it's nearly impossible for us to fix.
- Linking to a long list of all the mods in your pack isn't helpful. Figure out what mods cause it (or at least narrow it down to less than 10 mods), and report that.
- Is it actually something broken, or does it have more to do with your playstyle or another mod that behaves weirdly?
- If you have an idea for making the mod "better", I'm all ears...but I may disagree, and reserve the right to say "no" to any feature request.
- I can't promise 100% compatibility with all mods. Some stuff is just gonna break. That said, I'll do my best to make sure that game-breaking stuff gets patched somehow.
- If the bug has to do with another mod, removing all unnecessary mods ensures that there's no conflict.
Normally, I don't recommend using dev builds, but when you run into a bug, please check to see if it's still a problem in the latest released dev build. You could also try using the latest build from Jenkins, but those tend to be unstable at times. Making sure that any dependencies are up to date is a good idea too.
Once you know it's a bug, there's a couple of things that I absolutely must have. Reports without these will normally not get fixed, because there simply isn't enough information.
- Steps to reproduce. If I can't reproduce it, I can't fix it. I say this more than once because it's one of the more important bits.
- Steps to reproduce should be specific.
- If the bug involves multiple steps, be specific with all of them.
- Here's some examples:
- "When I right click on block Y, my client crashes."
- "Using item X from someOtherMod (version 1.2.3.4) to pick up block Y makes it lose all items from the inventory"
- "If I place block X next to block Y when sneaking, all nearby sand turns into lava"
- What version of Particle Physics are you running?
- Was there a crash? If so, I need the (vanilla) crashlog and your Forge log.
- Enable debugMode in the config. This prints extra information to the logs, and helps us figure out what is going on.
- Use Pastebin or some other text paste site for your crashlog/Forge log or any config files (don't use screenshots for text files please!).
- Pasting the full text into a ticket can make it hard to read.
- Using non-vanilla logs (eg, MultiMC) makes it more difficult to track down a bug. If we need more info, we'll ask.
- One bug per report. If you report multiple problems on a single issue report, it's often easy to get them mixed up or have partial fixes.
- Name it descriptively. An issue called "BROKEN!!!11" or "lots of buggggsss" isn't helpful. One named "Polytool right click crash" or "Decomposer upgrade request" is much better.
Adding this stuff can make my job a lot easier. It's not required, but better bug reports means a faster response from me.
- Screenshot(s) of the problem, ideally inline. To put a screenshot inline, use this code:
- Use links! If you have extra information, like a tool you used to find the problem, use the following code to make a link:
[text to display](http://the.link.to/your/tool/or/other/internet/resource
Often times, I'll have questions about the problem you report. Keep an eye on your bug report, because if I have a question, and you don't reply for a month, the bug may not get fixed until after you reply.
Questions, comments, confusion, need to check if something is how it's supposed to be? I hang out in the Esper.net #minechem channel, and you're welcome to drop by and chat. I'm always connected, but my timezone is GMT-8, so if I don't respond immediately, it may be because I'm sleeping or at work. Ping me (by saying my full username) and I'll get back to you as soon as I check IRC again.
I'm a mod developer in my spare time, and I do my best to respond immediately when bugs get reported. That said, I have a job and a life outside of Minecraft. Any bug that gets reported will get fixed eventually, as long as enough information is included.