Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 3.16 KB

after_party_tracking.md

File metadata and controls

66 lines (42 loc) · 3.16 KB
Raw

After-Party project tracking

This document describes how we track issues for the After-Party tracking on the project board is at https://github.com/orgs/sanger-tol/projects/3.

Standard fields

Status

Our workflow has three main steps:

  • Todo: This item hasn't been started.
  • In progress: This is actively being worked on.
  • Done: This has been completed.

with the addition of:

  • Triage: This item first needs to be confirmed or refined. Triage is optional, but would typically be used before Todo.
  • Blocked: This item is waiting on another one and can't be worked on.

Priority

We follow a simple model with three priority levels:

  • High
  • Medium
  • Low

Labels

There is a first set of labels about the kind of issue, that are mutually exclusive and should be set to almost every issue:

  • bug Something isn't working : Something isn't working
  • enhancement Improvement of the existing features : Improvement of the existing features
  • feature Requests for new features : New feature or request
  • maintain Tasks to keep pipelines up to date : Tasks to keep pipelines up to date

Most issues are expected to be about the code (software), but we have those two labels for non-code issues:

  • documentation Improvements or additions to documentation : Improvements or additions to documentation
  • testing Code testing : Code testing

These labels are used to indicate why an issue is closed early:

  • duplicate This issue or pull request already exists : This issue or pull request already exists
  • invalid This doesn't seem right : This doesn't seem right
  • wontfix This will not be worked on : This will not be worked on

External contributors can look for these labels:

Finally:

  • question Further information is requested : Further information is requested
  • user request Requests made by users and public : Requests made by users and public

Guidelines

Labels should follow the following rules:

  1. bug Something isn't working , enhancement Improvement of the existing features , feature Requests for new features , and maintain Tasks to keep pipelines up to date are mutually exclusive.
  2. Almost every issue should have one of bug Something isn't working , enhancement Improvement of the existing features , feature Requests for new features , or maintain Tasks to keep pipelines up to date .
  3. All issues with duplicate This issue or pull request already exists , invalid This doesn't seem right , or wontfix This will not be worked on , should be Done.
  4. All issues in Triage should have the question Further information is requested .
  5. Only Low priority issues should have the help wanted Open to anyone interested . This is to ensure we don't clash.