Skip to content

Github Issues

ParieMalhotra edited this page Mar 20, 2020 · 4 revisions

Github Issues are an easy way to keep track of the tasks that need to be done including bug fixes in the code. The team behind Threader use issues to manage tasks needing to be done. In order to easily organise our issues we use labels. We also have an approval system which is used to ensure all issues are clear, concise and not a duplicate.

Creating Issues

Issues can be created by any contributor. There are two types of issues that can be created - feature issues and bug issues. Each issue type has a template which should be used. Ensure all relevant fields are filled out with as much information as possible. A clear and detailed issue is likely to be approved faster than one which requires lots of additional information to be requested.

Issue Approvals

Issues can be approved by any contributor. All issues except for initial issues require 3 people to approve in order to attain the approved status. Initial issues are defined as those which have previously been discussed at team meetings. They require only one person to approve it before attaining the approved status. Prior to approving an issue it must be reviewed to ensure it is valid, contains enough information and not a duplicate of another issue. In order to show your approval for an issue, simply comment on the issue saying "I approve". Once 3 approvals have been received (or 1 approval for initial issues), the 'approved' label can be added to the issue.

Issue Labels

  • Approved: An issue with this label means it has been checked for validity and it is not found to be a duplicate issue.

  • Backend: An issue with this label means it relates to backend (could be a feature implementation or bug fix). The backend team is in charge of handling JSON packages including requests and responses. Click here to know more.

  • Blocked: An issue with this label means that it cannot be worked on until a linked issue is resolved first.

  • Bug: An issue with this label means that a fault has been found which needs correcting. As a result, a feature is not currently working in the desired manner.

  • Devops: An issue with this label means it relates to devops (could be a feature implementation or bug fix). The devops team is in charge of continuous integration and continuous deployment. Click here to know more about how it works.

  • Documentation: An issue with this label means it relates to documentation.

  • Duplicate: An issue with this label means there is already an existing issue which is similar.

  • Enhancement: An issue with this label means that it covers a new feature to be implemented.

  • Frontend: An issue with this label means it relates to frontend (could be a feature implementation or bug fix). The frontend team is in charge of how everything looks to the user. Click here to know more.

  • Good First Issue: An issue with this label means it is a good starting point for a newcomer.

  • Help Wanted: An issue with this label means extra attention is required on it.

  • Invalid: An issue with this label means that something is wrong, resulting in it not being deemed valid after review.

  • Question: An issue with this label means further information is required.

  • Seeking-Approval: An issue with this label means it is a newly created issue. It needs to be checked by other contributors for validity and originality.

  • Wontfix: An issue with this label means it will not be worked on.