Skip to content

How to Use GitHub Issues

Nicholas Jeans edited this page Nov 14, 2019 · 4 revisions

Why GitHub Issues?

Utilizing GitHub issues through their projects function will allow us a developer team to better organize our thoughts, write them down, and discuss details with other developers without the nitty gritty being lost into the Discord void. These issues will allow us to organize bugs and suggestions made by developers and other users into project boards where we can organize their progression through Kanban (much like Trello).

Create an Issue

Begin by clicking on the Issues tab along the top of our GitHub repository. It is through here we will gather our developer suggestions and bug reports. Now, click on the green New Issue button.

Choose and Edit Your Issue

Now, select your issue type, if it is a bug report, click the green button next to Re-Origination Request. If it is a suggestion, simply choose to create a regular issue.

You are now in the issue editor. Fill out the title of your bug/suggestion. If filling out a suggestion, make the title imperative or formulated like a command, much like the example below, to fit the format of other suggestions.

Categorize Your Issue

Now that your issue is written out and descriptive, you can now mark yourself as the writer (assignee) and label is as either a bug or suggestion through the two options on the side of the screen.

With the issue labeled, please select the respective project for your bug or suggestion. BUGS will go to the RE-ORIGINATION CRUSADE project, while SUGGESTIONS will go to the SUGGESTION BOARD project.

Submit your issue!

Clone this wiki locally