Skip to content

Bug Tracking

David Tuttle edited this page Dec 13, 2017 · 4 revisions

Bug Tracking Procedure

  • Bug Tracking will be handled using GitHub's built-in issues tab.
  • When a bug is discovered the reporter should create a new issue.
  • The reporter should add a comment on the issue including the following:
    • A brief description of the bug
    • Steps to reproduce the bug (when known)
  • The reporter should also include appropriate labels:
    • Status - Current status of the bug, to be updated as the bug reaches different points in its life cycle.
      • "bug" - Initial status of issue.
      • "reviewed" - Assignee has claimed issue fixed but has not been merged by another team member.
      • "resolved" - Bug fix has been merged to master
    • Priority - Left to the discretion of the reporter. Signifies the severity of the issue
      • "Low Priority" - Bugs resulting in cosmetic issues.
      • "Medium Priority" - Bugs affecting a single function.
      • "High Priority" - Bugs affecting core system operation.
      • "WontFix" - Bugs currently declared out of scope for the project.
    • Relevant Systems - Which portion of the architecture the issue is affecting.
      • Frontend(React)
      • Backend(Node.js)
      • Database(MySQL)
  • Issues should be additionally marked with a relevant milestone so they will alert developers by email of approaching deadlines.
  • Issues can then be assigned to a programmer by the reporter or programmers can assign themselves to unresolved issues.
  • The assignee then takes control of the issue, updating the status for the remainder of its lifetime.
Clone this wiki locally