From 96e7c0588deff705e0dd818de924793e6808b93c Mon Sep 17 00:00:00 2001 From: Robert Dromey <111453684+rdromey@users.noreply.github.com> Date: Thu, 31 Oct 2024 16:12:59 -0700 Subject: [PATCH] Chore: Update issue templates --- .github/ISSUE_TEMPLATE/bug-template.md | 38 ++++++++++----- .../service-design-task-template.md | 48 +++++++++++++++++++ .github/ISSUE_TEMPLATE/task-issue-template.md | 13 +++-- .github/ISSUE_TEMPLATE/tech-debt-template.md | 37 ++++++++++++++ .github/ISSUE_TEMPLATE/user-story-template.md | 45 ++++++++++++++--- 5 files changed, 160 insertions(+), 21 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/service-design-task-template.md create mode 100644 .github/ISSUE_TEMPLATE/tech-debt-template.md diff --git a/.github/ISSUE_TEMPLATE/bug-template.md b/.github/ISSUE_TEMPLATE/bug-template.md index 603d9cc3f8..9694b24e3a 100644 --- a/.github/ISSUE_TEMPLATE/bug-template.md +++ b/.github/ISSUE_TEMPLATE/bug-template.md @@ -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 + + +#### 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 + +- diff --git a/.github/ISSUE_TEMPLATE/service-design-task-template.md b/.github/ISSUE_TEMPLATE/service-design-task-template.md new file mode 100644 index 0000000000..53f9e72986 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/service-design-task-template.md @@ -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) diff --git a/.github/ISSUE_TEMPLATE/task-issue-template.md b/.github/ISSUE_TEMPLATE/task-issue-template.md index 575c3c06fd..cdaac7690c 100644 --- a/.github/ISSUE_TEMPLATE/task-issue-template.md +++ b/.github/ISSUE_TEMPLATE/task-issue-template.md @@ -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]" @@ -9,6 +9,7 @@ assignees: '' --- #### Describe the task + A clear and concise description of what the task is. #### Acceptance Criteria @@ -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 diff --git a/.github/ISSUE_TEMPLATE/tech-debt-template.md b/.github/ISSUE_TEMPLATE/tech-debt-template.md new file mode 100644 index 0000000000..3aa907f4d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/tech-debt-template.md @@ -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 |