Issue System - bounswe/bounswe2016group8 GitHub Wiki

Issue System

GitHub Issues are a communication system used for keeping track of tasks. Issues can inform the project members about needed improvements, bugs, and requests.

For public repositories any github user can create an issue. The issues have certain attributes such as labels, milestone, assignee, and comments.

Labels

As there can be excessive amount issues, it is good for all to have some categorization among them. Labels come in handy in this respect. There are different labels of issues so that we can choose what we are mostly interested, or we can eliminate among them by their labels. Labels help a lot from this perspective, they save a lot of time and make everything easier for both sides. We are going to mention about them in terms of their types, priorities, and severity. To start with, we can list the types as :
  1. Feature
    This type is for new functionalities, improvements, refactors, etc.
  2. Bug
    The issue documents are broken,incorrect or they do not function properly.
  3. Upstream Bug
    The issue is a result of an upstream issue.
  4. Question
    This type is more like asking a question instead of demanding something.
  5. Expected Behavior
    The issue is a bug report of intended functionality.
  6. Duplicate
    The issue is a duplicate of another feature request or bug report.

As for the priorities, we have basically 4 different types as follow :

  1. P1
    The issue will be seen by all users.
  2. P2
    Most of the users will see the issue.
  3. P3
    Almost half of the users can see the issue.
  4. P4
    This type of issue will be seen by only some users.It is not concern of most users.

As the last one we have severity issues, but it is good to note that in general they are considered as “bug” issues.

  1. Blocker
    The issue is blocking an impending release.
  2. Critical
    The issue causes data loss, crashes or hangs salt processes, makes the system unresponsive, etc.
  3. High Severity
    The issue reports incorrect functionality, bad functionality, a confusing user experience, etc.
  4. Medium Severity
    The issue reports cosmetic items, formatting, spelling, colors, etc.

Milestones

Milestones are groups of issues related to a certain project or task. A Milestone’s progress can change by assigning or closing issues.

Assignee:

Each issue can have one assignee. Assignees are responsible for moving the issues forward.

Mentions:

Mentions are used to reference certain GitHub users in issues, the syntax is @username.

⚠️ **GitHub.com Fallback** ⚠️