Skip to content

Home

Jump to bottom
Griffin edited this page Aug 14, 2021 · 15 revisions

Understanding GitHub

Its a nerd toy. Typically nerd-grammers post their code here, with the ability to post updates, report bugs, and other nerd-stuffs. Think social media for programmers. they can share code-stuff and keep all the versions of something in one place, track updates and stuff. But since you can report issues and comments and stuff, Griffin has adapted it to serve as his to do list, bug reporting, and idea page all in one -- Filid, 7/9/17

We are using GitHub as a replacement to Wunderlist to track tasks/projects and bugs.

Issues

Issues can be thought of as many things, depending on the content of the issue. Generally we will be using them to store all the information relevant to task, as to-do list items/reminders, or as bug reports.

Title

This is a short (almost always less than 50 characters) description of the content of the "issue" (remember, an issue is not necessarily a problem- it's whatever we make it). You should be able to identify in a general sense what the issue is about by the title.

Good titles
  • Bane trade sign unresponsive
  • Can't use bane trade sign
Bad titles
  • Shops broken
  • RIP Trade sign
  • Fix the thing

Body

This is where you include all the information related to the issue. If it is a bug report, screenshots, test results, etc should be included. If the issue is a task, things you include could be steps to complete the task, chat logs of the task being brainstormed, notes, links, and so on.

Labels

Labels can tell you many different things; most commonly, it is what the issue involves and/or requires. For example, many issues are tagged with code because they will require me to code something. Some issues are tagged plugin because they involve a plugin not maintained by me.

Assignees

People that are in charge of completing the issue, whether that means fixing a bug or brainstorming ideas for a new feature or what ever else the task details. If you are assigned an issue, that issue is your responsibility.

Projects

Projects are ongoing, big picture tasks. Currently we have 6 projects; Survival, Minigames, Skyblock, Store, Quality and Features, and Backend and Maintainability. These are the most actively developed parts or ideas of the server. They all have multiple issues attached to them, which can be tagged as 'Ideas', 'In Progress', and more.

Using the website

Issues

Issue page

  1. The issues tab. You will need to click this before you see any of the rest of the items
  2. New issue button
  3. Issue assignee(s); who is tasked with the completion of the issue.
  4. Issue ID. You can reference issues by their IDs both in Jayce commands and in comments.
  5. Issue labels
  6. Issue comment count

Jayce

Jayce is a bot that I developed to allow you to use GitHub without needing to open GitHub. Say you found a bug that the Admins need to address; instead of needing to:

  1. Open a browser
  2. Navigate to https://github.com
  3. Login if needed
  4. Navigate to the repository, and
  5. Submit the issue

you can simply

  1. Open Discord, and
  2. Use the !issue create command

Usage

Command: !issue, !issues

< > = required, [ ] = optional

Basic issue modification

Create an issue

!issue create <short desc> | <longer description>
# Ex: !issue create Bane trade signs don't work | MonopolyBear reported to me etc...
# Note: The body supports GitHub markdown and emojis.

Edit an existing issue

!issue edit <id> <title|body> <content>
# Ex: !issue edit 3 title Bane book trade signs are unresponsive

Comment on an issue

!issue comment <id> <comment>
# Ex: !issue comment 3 We have discovered that Sweeping Edge books behave the same way

Close an issue

!issue close <id>
# Ex: !issue close 3

Reopen an issue

!issue open <id>
# Ex: !issue open 3

Labels and assigning

Add/remove a label

!issue label[s] <id> <add|remove> <labels>
# Ex: !issue labels 3 add code minigames
# Ex: !issue label 3 remove minigames

Assign/unassign a user

!issue assign <id> @<user> 
# Ex: !issue assign 3 @Griffin
# Note: Make sure you @mention the user.

Search

Search issue titles and comments for keywords

!issue search <query>
# Ex: !issue search koda
# Ex: !issue search is:closed wiki
# Ex: !issue search assignee:GriffinCodes
Clone this wiki locally