Issue Description

Before Creating an Issue

Before creating an issue, check that there doesn't already exist an issue about that topic. If you have any more information to add, maybe you could create a comment there instead.

Title

The title of the issue should be short and to the point, summing up the issue/task.

Main body

The main body of the issue should give as much explanation as needed, which is dependent on the situation.

Bug

If the issue is a bug, then try to give as much explanation as possible about when the bug occurs. If possible give a minimum example on how to reproduce the bug, add logs if you have any. The more we know about the issue, the faster we can find a solution. Obviously, if you don't see any patterns, still report it. Also remember to state what the consequences are, is the game crashing, or is it just that something suddenly gets the wrong color?

Task

The exact detail level of the task depends a bit on who you are writing it for. If you are writing it for yourself or it is obvious what should be done, you don't need to be as detailed. However, in general prefer to keep it relatively detailed. Also try to keep the task specific, so that we can know when we are done.

Suggestion

Something you think should be done differently, or should be added, add one here as a reminder?

Related Issues

If this issue is somehow related to another issue, for example they sort of concern the same area, add a reference to the other issue by writing: "ref #<issue_number>"
Example:

ref #14 

Label & Priority

Add a label to the issue, so we can more easily categorize it. Mostly the labels we will be using for issues are:

• task
• bug
• suggestion

Also add a priority label if applicable. By default all issues are "medium" priority, however, if something isn't very important, give it a low priority label.
Additionally critical label can be used to identify critical issues to be dealt with. These are stuff like game breaking bugs (crashing, hanging, corrupting files etc), or tasks that needs to be done for the game to function. Basically, setting something to critical means: "Drop whatever you are doing, and fix this!"

Examples

Bug

Good

Game crashes when I turn left, division by zero error

The game crashes when I am playing in the Vive and turn to the left 
while pointing the right motion controller at my face.

Right before crashing I get a message in Unity saying:
"Uncaught exception division by zero"

Here are logs:
"Controller.cs: Trying to divide by zero"

Bad

The game crashes!

The game crashes when I turn left.