Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Bug Reporting Best Practices

XCompWiz edited this page May 16, 2020 · 1 revision

When reporting that something went wrong, it's important to provide as much information as possible.

A good bug report has:

  • What happened
  • What you expected
  • How to reproduce this as simply and swiftly as possible.

If an error or crash was involved, be sure to include the log or error message.

Mystcraft issues

My preferred reports have been tested with only Mystcraft installed, no other mods. These simplify the variable state a lot.

Mod compatibility issues

I don't have the time to debug every mod compatibility issue. It's up to the community to find the minimal set of mods which produce an issue.

The best way to determine which mod is currently conflicting with Mystcraft is "binary search". Take half of the mods you have installed (and Mystcraft) and test them. If the problem persists then it's in that set. If not, then it should be in the other set. You can keep dividing the mods installed in half to eventually get to a point where you can test mods individually.

The downside here is that this assumes that it's ONE other mod in conflict. If the bug only occurs when a set of three or more mods are involved then it gets more complicated. I recommend that you always try both splits. If neither split has the issue then you are dealing with a multiple mod interaction. Shuffle your splits and try again.

If you can make a guess in advance you can try to remove mods you think are not involved with the issue. You'll need to test this subset, still, but this step can help when you think the issue is probably a particular interaction.

Clone this wiki locally