Creating an Issue

Guidelines

We're working on how to create a high quality issue. After some research on this site, I think the format is pretty good. To summarize a good issue should have:

A Concise Title

Describe the issue in as few words as possible

• Good - Create a menu
• Bad - Make a menu with 4 buttons: play, join, host, quit, and make the buttons work

Context

The first thing you type should be context for the issue, why is this issue coming up? Is it part of a larger plan? Continuing the example of creating a menu you might say:

• "Our game needs a starting menu for players to navigate servers in for the upcoming implementation of networking."

Problem or idea

The context should lead to a problem or new idea. Here the problem or idea must be described concisely. Continuing the example an idea might be stated for the Create a menu issue.

• "I was thinking our menu could consist of 4 buttons: play, join, host, and quit that would lead to different places in game. Play to the single player, join to look for a server, host to make a server, and quit would exit the game."

Solution or next step

After you state a problem or idea you need to close with what's next. If it's a problem, either propose a solution or ask for suggestions:

• "This could be approached through a single button object that changes it's function depending on its position. When clicked the player would move to the next corresponding menu."

If you have an idea you might open it to discussion or state the next steps that need to be taken. Here is also a good place to mention people with the @ symbol who are most relevant to the issue.