Skip to content

Issues: Labeling guideline

Tomas Kral edited this page Mar 23, 2023 · 8 revisions

This document describes how the project makes use of different labels and what they mean.

Rules:

  • Every issue should have exactly one kind label.
  • Only user-story, task or bug

Kind

A kind/* label helps distinguish among the different kinds of issues:

  • kind/epic - Big user story that needs to be broken down. Epics group together bugs, stories, and tasks to show the progress of a larger effort. It usually represents a significant deliverable, such as a new capability or experience.
  • kind/user-story - Smallest unit of work that needs to be done and is end user-facing. It helps explain the feature from an odo user's point of view. User story issues should also contain a list of Acceptance criteria that helps identity what it means to complete this user story.
  • kind/task - Unit of work that needs to be accomplished but is not end-user facing.
  • kind/bug - A bug is a problem that negatively effects one or more functions.
  • kind/feature-request - A request directly filed by a user. Feature Requests come from the user and the scope and size may not be clear. Feature Requests must be groomed into User story or Task before they can be worked on.

priority

  • priority/Low - Nice to have issue. It's not immediately on the project's roadmap to get it done.
  • priority/Medium - Nice to have issues. It's soon going to be required. Getting it done before it becomes priority/High would be a good idea.
  • priority/High - Important issue; should be worked on before any other issues (except priority/Critical issue(s)).
  • priority/Critical - Stop doing everything and fix this ASAP. It is making the project unusable.