Skip to content

Commit

Permalink
Chore: Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
rdromey authored Oct 31, 2024
1 parent bb8502f commit 147c335
Show file tree
Hide file tree
Showing 8 changed files with 127 additions and 91 deletions.
46 changes: 28 additions & 18 deletions .github/ISSUE_TEMPLATE/bug-template.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,38 @@
---
name: Bug template
name: Bug Template
about: For documenting bugs as per our bug process
title: "[bug title]"
labels: bug
assignees: ""
title: ''
labels: Bug
assignees: ''

---

Describe the Bug:
#### Describe the Bug:

#### Probability:

(How likely the bug is to happen, scored from 1-5. For example, probability of 5 is something like "it happens to all users every time they log in." whereas probability of 1 "only happens to certain users when a really specific and unlikely path is followed.")

#### Impact:

(How bad the bug is when it does happen, scored from 1-5. For example, effect of 5 is "the entire app crashes and makes it unusable for all users" or "the bug causes the wrong data to be saved, with critical information (e.g. payment) being affected." whereas effect of 1 is "It makes some styling look a little bit weird.")

<img src="https://www.getzephyr.com/sites/default/files/riksk%20matrix.jpg" alt="Bug Matrix" width="250" height="250"/>

#### Steps to reproduce the behaviour:

Probability (how likely the bug is to happen, scored from 1-5):
(For example, probability of 5 is something like "it happens to all users every time they log in."
Probability of 1 "only happens to certain users when a really specific and unlikely path is followed.")
1. Step #1
2. Step #2
3. Step #3

Effect (how bad the bug is when it does happen, scored from 1-5):
(For example, effect of 5 is "the entire app crashes and makes it unusable for all users" or "the bug causes the wrong data to be saved, with critical information (e.g. payment) being affected."
Effect of 1 is "It makes some styling look a little bit weird.")
#### Screenshots:

Steps to reproduce the behaviour:
#### Additional information:

Screenshots:
OS: [e.g. iOS]
Browser: [e.g. chrome, safari]
Version: [e.g. 22]

Additional information:
#### Additional Context

- OS: [e.g. iOS]
- Browser: [e.g. chrome, safari]
- Version: [e.g. 22]
- Additional context
-

This file was deleted.

48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/service-design-task-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: Service Design Task Template
about: Service Design Task Template
title: ''
labels: Backlog Refinement, Service Design
assignees: ''

---

#### Goal of Ticket

#### Describe the Task

A clear and concise description of what the task is.

#### Acceptance Criteria

- [ ] first
- [ ] second
- [ ] third

#### Additional context

Add any other context about the task here.

#### Definition of Ready:

Note: If any of the points are not applicable: delete or mark N/A

- [ ] Topic is clearly defined
- [ ] Task description is clear
- [ ] People to speak to are identified (if applicable)
- [ ] Acceptance Criteria is clear
- [ ] Ticket title is clear
- [ ] Ticket is reasonably split up/sized
- [ ] Value/Pain is clear
- [ ] Relevant team members are assigned
- [ ] Ticket estimated (if required)

#### Definition of Done.

Note: If any of the points are not applicable: delete or mark N/A

- [ ] Rough user stories proposed
- [ ] Follow-up tickets created (if necessary)
- [ ] Findings are documented (if necessary)
- [ ] Reference docs/spreadsheets identified and indexed
- [ ] Value proposition canvas (if required)
14 changes: 10 additions & 4 deletions .github/ISSUE_TEMPLATE/task-issue-template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
name: Task issue template
about:
For cards that are not user stories, but may be technical, UX-related, or other
name: Task Issue Template
about: For cards that are not user stories, but may be technical, UX-related, or other
tasks.
title: "[title of task]"
labels: Task
assignees: ""
assignees: ''

---

#### Describe the task
Expand All @@ -18,6 +18,12 @@ A clear and concise description of what the task is.
- [ ] second
- [ ] third

#### Definition of Done

- [ ] first
- [ ] second
- [ ] third

#### Additional context

- Add any other context about the task here.
Expand Down
40 changes: 24 additions & 16 deletions .github/ISSUE_TEMPLATE/tech-debt-template.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,37 @@
---
name: Tech Debt Template
about: Tech Debt Template
title: ""
title: ''
labels: Tech Debt
assignees: ""
assignees: ''

---

###Description of the Tech Debt###
#### Description of the Tech Debt

#### Tech Debt Triage

###Tech Debt Triage#
The purpose of our technical debt triage process is to analyze technical debt to determine risk level of the technical debt and the value in tackling that technical debt.

Risk Value Scoring:
#### Risk Value Scoring:

| Level | Value |
| ------ | ----- |
| High | 3 |
| Medium | 2 |
| Low | 1 |
| Level | Value |
| ------ | --------------------- |
| High | <div align="center">3 |
| Medium | <div align="center">2 |
| Low | <div align="center">1 |

| Technical Debt - Risk Types | Level | Value |
| ----------------------------------------------------------------------------------------------------------------------------- | ----- | ----- |
| Business Area Risk - Risk of business area visibility / damage to user experience | | |
| Developer Fault Risk - How likely will this tech debt cause a future error related to coding on top of it | | |
| System Fault Risk - Risk of system errors or application downtime | | |
| Time Scale Risk - Compound risk effect if left alone. How much more difficult to fix or dangerous will this become over time? | | |
| Time Sink Risk - How much will this tech debt slow the development process down | | |
| TOTAL SCORE: | | |
| Business Area Risk - Risk of business area visibility / damage to user experience | 0 | 0 |
| Developer Fault Risk - How likely will this tech debt cause a future error related to coding on top of it | 0 | 0 |
| System Fault Risk - Risk of system errors or application downtime | 0 | 0 |
| Time Scale Risk - Compound risk effect if left alone. How much more difficult to fix or dangerous will this become over time? | 0 | 0 |
| Time Sink Risk - How much will this tech debt slow the development process down | 0 | 0 |
| <div align="right">**TOTAL SCORE:** | 0 | 0 |

#### Development Checklist:

- [ ] Checklist item
- [ ] Checklist item
- [ ] Checklist item
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
name: Testing/Feedback Gathering Task Template
about: Testing/Feedback Gathering Task Template
title: ""
labels: ""
assignees: ""
title: ''
labels: ''
assignees: ''

---

#### Describe the task
Expand Down
15 changes: 9 additions & 6 deletions .github/ISSUE_TEMPLATE/user-story-template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
name: User Story Template
about:
User stories are broken down product backlog items that are user-focused and
about: User stories are broken down product backlog items that are user-focused and
vertically-sliced.
title: As a [user], I want to [what], so that [why]
labels: User Story
assignees: ""
labels: Backlog Refinement, User Story
assignees: ''

---

#### Description:
Expand All @@ -25,7 +25,7 @@ Then
- [ ] Checklist item
- [ ] Meets the DOD

**Definition of Ready** (Note: If any of these points are not applicable, mark N/A)
#### Definition of Ready (Note: If any of these points are not applicable, mark N/A)

- [ ] User story is included
- [ ] User role and type are identified
Expand All @@ -35,7 +35,7 @@ Then
- [ ] Dependencies are identified (technical, business, regulatory/policy)
- [ ] Story has been estimated (under 13 pts)

·**Definition of Done** (Note: If any of these points are not applicable, mark N/A)
#### Definition of Done (Note: If any of these points are not applicable, mark N/A)

- [ ] Acceptance criteria are tested by the CI pipeline
- [ ] UI meets accessibility requirements
Expand All @@ -47,6 +47,9 @@ Then
- [ ] Bugs or future work cards are identified and created
- [ ] Reviewed and approved by Product Owner

#### Blocked By/Blocking


#### Notes:

-
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
name: Wireframe + iterations/refinement Task Template
about: Wireframe + iterations/refinement Task Template
title: ""
labels: ""
assignees: ""
title: ''
labels: ''
assignees: ''

---

#### Describe the task
Expand Down

0 comments on commit 147c335

Please sign in to comment.