Skip to content

Bug Reporting Guidlines

BookerTheGeek edited this page Mar 13, 2017 · 2 revisions

I love bug reports. It means you found something wrong, and want to help make the pack 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. Also check if there is already a existing issue which look similar like your one.

Is it a bug?

The first step in submitting a good bug report is making sure it's actually a bug with the pack and not something we have done on purpose. This seems like a no-brainer, but there's a lot of bugs that will get reported which will have more to do with changes we've made vs the mods not working.

  • 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 us the steps to reproduce it. Knowing that there is a bug out there that we can't fix because we can't find it is really frustrating for us.

Are you running the latest version?

Normally, the latest release will be submitted to Curse on Saturday sometime. When they update it their is beyond our control

Basic requirements

Once you know it's a bug, there's a couple of things that we absolutely must have. Reports without these will normally not get fixed, because there simply isn't enough information.

  • Steps to reproduce. If We can't reproduce it, We can't fix it. We 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"
  • Was there a crash? If so, we need the 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 Gist, 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 and result in us closing the issue without looking at it.
  • 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.

Feedback

Often times, We'll have questions about the problem you report. Keep an eye on your bug report, because if we have a question, and you don't reply for a month, the bug may not get fixed until after you reply.

  • If you have an idea for making the pack "better", I'm all ears...but we may disagree, and reserve the right to say "no" to any feature request.

Patience

We are mod pack makers in our spare time, and we do my best to respond immediately when bugs get reported. That said, we 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.

Clone this wiki locally