Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Update issue templates #2285

Merged
merged 1 commit into from
Nov 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 26 additions & 12 deletions .github/ISSUE_TEMPLATE/bug-template.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,38 @@
---
name: Bug template
name: Bug Template
about: For documenting bugs as per our bug process
title: "[bug title]"
labels: bug
labels: Bug
assignees: ''

---

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

Probability (1-5):
#### Probability:

Effect (1-5):
(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.")

Steps to reproduce the behaviour:
#### Impact:

Screenshots:
(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.")

Additional information:
* OS: [e.g. iOS]
* Browser: [e.g. chrome, safari]
* Version: [e.g. 22]
* Additional context
<img src="https://www.getzephyr.com/sites/default/files/riksk%20matrix.jpg" alt="Bug Matrix" width="250" height="250"/>

#### Steps to reproduce the behaviour:

1. Step #1
2. Step #2
3. Step #3

#### Screenshots:

#### Additional information:

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

#### Additional Context

-
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)
13 changes: 10 additions & 3 deletions .github/ISSUE_TEMPLATE/task-issue-template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Task issue template
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]"
Expand All @@ -9,6 +9,7 @@ assignees: ''
---

#### Describe the task

A clear and concise description of what the task is.

#### Acceptance Criteria
Expand All @@ -17,7 +18,13 @@ 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.
* Or here
- Add any other context about the task here.
- Or here
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/tech-debt-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Tech Debt Template
about: Tech Debt Template
title: ''
labels: Tech Debt
assignees: ''

---

#### Description of the Tech Debt

#### 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:

| 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 | 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
45 changes: 39 additions & 6 deletions .github/ISSUE_TEMPLATE/user-story-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,53 @@ name: User Story Template
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
labels: Backlog Refinement, User Story
assignees: ''

---

#### Description:

Brief description of the work involved, including any user research context or key decisions.

#### Acceptance Criteria:
* Option - use Ghirken:

Given
When
Then
* [Other AC]
* [Other AC]
* [Other AC]
* Meets the DOD

#### Development Checklist:

- [ ] Checklist item
- [ ] Checklist item
- [ ] Checklist item
- [ ] Meets the DOD

#### 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
- [ ] Acceptance criteria are included
- [ ] Wireframes are included (if required)
- [ ] Design / Solution is accepted by Product Owner
- [ ] 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)

- [ ] Acceptance criteria are tested by the CI pipeline
- [ ] UI meets accessibility requirements
- [ ] Configuration changes are documented, documentation and designs are updated
- [ ] Passes code peer-review
- [ ] Passes QA of Acceptance Criteria with verification in Dev and Test
- [ ] Ticket is ready to be merged to main branch
- [ ] Can be demoed in Sprint Review
- [ ] Bugs or future work cards are identified and created
- [ ] Reviewed and approved by Product Owner

#### Blocked By/Blocking


#### Notes:

-
Loading