Skip to content

using Issues

Jump to bottom
Nhi edited this page Apr 6, 2019 · 4 revisions

Making an issue

The first comment of an issue

  • Should summarise the issue
  • Important as you can quickly view the first comment without the need to open the issue in a new tab

Title

  • The title is the summary of the issue.
  • In a board or the Issue tabs, you will always see the title on each issue.

Fields

  • Description Anything you want to say about the issue
  • Estimation (hours) How much time you think it will take to finish this issue.
  • Blocked by (optional) If the issue is blocked by another issue link here along with explanation of necessary.
  • Deadline (optional) If the issue has a separate deadline from the sprint (Bad idea?) or for use in planning project board.
  • Priority Can be Low, N/A, Medium, High and Dear God.
  • Component Used to categorize a issue into a component Eg: Colour. Allows us to search then for all issues relating to a component.

Checklist

An issue is considered to have been provided enough information when it has at least the following

  1. Summary of the issue
  2. Estimation (required for knowing how much we can carry in a sprint)
  3. Appropriate labels to be added
  4. Milestone (default to Backlog)
  5. Project (default to Backlog Board) - a card can belong to many sprints but it cannot currently be in a sprint and in a backlog

Templates

To make everyone's life easier, you can save the template as your saved reply. Or you can visit here every time you create an issue.

General Issue

Markdown

## Description
_Write a few lines here about the issue_

* **Estimation (hours)** _0.5 or 1 or 2 or 3 or etc._
* **Blocked by (optional)** _Link to the issues or reason or person that is blocking this issue_
* **Deadline (optional)** 
* **Priority** _Low, N/A, Medium, High and Dear God_

## Relevant links
_Suggestion: Put links for spike report, references to your solution for this issue here_

Preview

Description

Write a few lines here about the issue

  • Estimation (hours) 0.5 or 1 or 2 or 3 or etc.
  • Blocked by (optional) Link to the issues or reason or person that is blocking this issue
  • Deadline (optional)
  • Priority Low, N/A, Medium, High and Dear God

Relevant links

Suggestion: Put links for spike report, references to your solution for this issue here

Spike Report Issue

Mark Down

* **Estimation (hours)** _0.5 or 1 or 2 or 3 or etc._

**Blocked By**: #4 (Spike Report Colour Red), #5 (Spike Report Colour Green)

**DeadLine**: N/A

**Priority**: High

**Component**: N/A

Preview

I need a spike report about the colour.

Labels:

  • Documentation

Blocked By: #4 (Spike Report Colour Red), #5 (Spike Report Colour Green)

DeadLine: N/A

Priority: High

Component: Colour

Bug Issue

Mark Down

## Description 

After commit a5c3785ed8d6a35868bc169f07e40e889087fd2e when x is pressed 20 times and you spin around 3 / 4 times the page crashes and dumps this.

etc, etc. 
* **Estimation (hours)** 0.5
* **Blocked By**: None
* **DeadLine**: N/A
* **Priority**: Low
* **Component**: Customer_Login

Preview

Title: Crashes the login page when x is pressed 20 times and you spin around 3 / 4 times.

Labels:

  • Bug

Description

After commit a5c3785ed8d6a35868bc169f07e40e889087fd2e when x is pressed 20 times and you spin around 3 / 4 times the page crashes and dumps this.

etc, etc.

  • Estimation (hours) 0.5
  • Blocked By: None
  • DeadLine: N/A
  • Priority: Low
  • Component: Customer_Login

Closing An issue

Documentation Label

You should leave a comment linking to the documentation location.

Example:

Issue: Make header for issues including required data.

Closing comment: Can be found here

Home

Spike reports

About

Documents

Clone this wiki locally