GitHub Tutorial - SeoulSKY/safe-zone-system GitHub Wiki

Issues

  • Issues are descriptions what work needs to be done
  • Issues are created by the project manager, the development lead, and the testing lead

Issue Types

  • Development
    • Task to create a new part of a feature for the system
  • Test
    • Task to implement some tests for a new feature
  • Documentation
    • Task to create wiki pages to describe or document stuff
  • Bug
    • Task to report and eventually fix a bug

Bug Reports

  • Bugs are issues created whenever a fault/fault/error/crash is found with the system
  • Bug reports are to include the following information to help fix the diagnose and fix the bug
    • Software version
    • Steps to reproduce
    • Expected results
    • Actual results
    • Any other information

Project Boards

  • There are 2 different project boards for the project: development and bug reports

Development

  • This board gets all new development, testing, and documentation issues
  • These issues are worked on by everyone
  • Issues go through the following workflow
    • Backlog -> In Sprint -> In Progress -> Review -> Done

Triage

  • This board gets all new bug issues
    • Basically anything that isn't working properly
  • They get classified by the project manager or testing lead
    • There are 3 categories of bugs
      • High priority
        • These bugs block an entire major feature or system from being used.
        • Releases should not include any of these bugs
      • Medium priority
        • These bugs block part of a major feature or an entire minor feature from being used.
        • Releases should not have any of these bugs, however, a couple may be allowed provided that workarounds are provided
      • Low priority
        • These bugs are annoyances, misleading functionality/tooltips, or poor UI design that does not affect the functionality but affects
        • Releases can have these bugs as long as they are documented as workarounds are provided
  • They get fixed by the development team
  • They get tested by the testing team
    • If the bug is no longer present then the testing team will moved the but to done.
    • If a bug is not actually fixed then the testing team moves the bug back for the developers to fix properly
  • Issues go through the following workflow
    • Backlog -> High/Medium/Low Priority -> Test-> Done
    • If a bug in testing is still present is goes back to its original category