Skip to content

Making meaningful reports

GrantSP edited this page Jan 10, 2016 · 1 revision

Steps in brief.

  1. Make the title as succinct as possible.
  2. Describe in detail the exact settings that generated the error including ALL mods that you have active, beyond those of the project itself.
  3. If the error is of a graphical nature, stating whether you have EUI active or not will assist.
  4. Any screenshots supplied should clearly highlight the error and have no extraneous details to obscure the true culprit.

##Specifics to keep in mind

###The Problem Simply stating you experienced a bug doesn't really help a great deal. The goal of reporting a bug is to get the bug fixed. The goal in creating an issue report should be to make it as easy as possible for the error to be found and eliminated. Since you're the one creating the report the onus is on you to provide as much detail as possible. Perhaps the setup you have is the difference, maybe the steps you took to get to that position were different to most users?

###The Solution

  1. Include steps to reproduce the problem as reliably as possible
  2. Include what you expected to happen
  3. Include what actually happened

It is best to have a setup that matches the development setup as closely as possible, but since we want to play the game, that may not always be possible, so to ensure ALL details about the game are revealed, outline any other mods on top of the CBP package that you are running.

When describing the problem and your steps to see this issue, try to avoid the assumption that the reader knows what you are thinking. By that I mean if there are more than one way to do what you are doing, outline the steps YOU took to get there. Sometimes this is where screenshots are used, because everyone has heard the adage about "a thousand words...". However, a single shot may not provide ALL the detail so please be liberal in your descriptions.

Remember, it costs nothing to write a report except your time and the time you spend may save the developers time in fixing it.

###Conclusion Writing reports about issues is a collaborative action. The steps you have taken are because you appreciate the work put forward in creating this package and want to help. So after posting your report be sure to return to see all instructions about the progress and possible solution. We all enjoy this mod and we all can share in its development.

Clone this wiki locally