From 82cbb08d41e7727c0f330a655f3509f1b20f7c48 Mon Sep 17 00:00:00 2001 From: Robert Dromey <111453684+rdromey@users.noreply.github.com> Date: Thu, 31 Oct 2024 16:13:16 -0700 Subject: [PATCH] Chore: Update issue templates --- .github/ISSUE_TEMPLATE/bug-template.md | 9 ++-- ...covery-and-service-design-task-template.md | 47 ------------------ .../service-design-task-template.md | 48 +++++++++++++++++++ .github/ISSUE_TEMPLATE/task-issue-template.md | 14 ++++-- .github/ISSUE_TEMPLATE/tech-debt-template.md | 27 +++++++---- .github/ISSUE_TEMPLATE/user-story-template.md | 17 ++++--- 6 files changed, 91 insertions(+), 71 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/discovery-and-service-design-task-template.md create mode 100644 .github/ISSUE_TEMPLATE/service-design-task-template.md diff --git a/.github/ISSUE_TEMPLATE/bug-template.md b/.github/ISSUE_TEMPLATE/bug-template.md index 29e6a425..1d4885d5 100644 --- a/.github/ISSUE_TEMPLATE/bug-template.md +++ b/.github/ISSUE_TEMPLATE/bug-template.md @@ -1,9 +1,10 @@ --- name: Bug Template about: For documenting bugs as per our bug process -title: "" -labels: bug -assignees: "" +title: '' +labels: Bug +assignees: '' + --- #### Describe the Bug: @@ -21,6 +22,8 @@ assignees: "" #### Steps to reproduce the behaviour: 1. Step #1 +2. Step #2 +3. Step #3 #### Screenshots: diff --git a/.github/ISSUE_TEMPLATE/discovery-and-service-design-task-template.md b/.github/ISSUE_TEMPLATE/discovery-and-service-design-task-template.md deleted file mode 100644 index a243ba3e..00000000 --- a/.github/ISSUE_TEMPLATE/discovery-and-service-design-task-template.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: Discovery and Service Design Task Template -about: Discovery and Service Design Task Template -title: "" -labels: "" -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. - -#### 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/service-design-task-template.md b/.github/ISSUE_TEMPLATE/service-design-task-template.md new file mode 100644 index 00000000..53f9e729 --- /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 a894286b..d5175dd8 100644 --- a/.github/ISSUE_TEMPLATE/task-issue-template.md +++ b/.github/ISSUE_TEMPLATE/task-issue-template.md @@ -1,11 +1,11 @@ --- name: Task Issue Template -about: - For cards that are not user stories, but may be technical, UX-related, or other +about: For cards that are not user stories, but may be technical, UX-related, or other tasks. -title: "" +title: '' labels: Task -assignees: "" +assignees: '' + --- #### Describe the task @@ -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. diff --git a/.github/ISSUE_TEMPLATE/tech-debt-template.md b/.github/ISSUE_TEMPLATE/tech-debt-template.md index bdba9aa8..5393023b 100644 --- a/.github/ISSUE_TEMPLATE/tech-debt-template.md +++ b/.github/ISSUE_TEMPLATE/tech-debt-template.md @@ -1,12 +1,13 @@ --- name: Tech Debt Template about: Tech Debt Template -title: "" -labels: "" -assignees: "" +title: '' +labels: '' +assignees: '' + --- -### Description of the Tech Debt +#### Description of the Tech Debt #### Tech Debt Triage @@ -22,9 +23,15 @@ The purpose of our technical debt triage process is to analyze technical debt to | 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 | +|
**TOTAL SCORE:** | 0 | 0 | + +#### Development Checklist: + +- [ ] Checklist item +- [ ] Checklist item +- [ ] Checklist item diff --git a/.github/ISSUE_TEMPLATE/user-story-template.md b/.github/ISSUE_TEMPLATE/user-story-template.md index 4a41359a..cb38049a 100644 --- a/.github/ISSUE_TEMPLATE/user-story-template.md +++ b/.github/ISSUE_TEMPLATE/user-story-template.md @@ -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: "" -labels: User Story -assignees: "" +title: '' +labels: Backlog Refinement, User Story +assignees: '' + --- #### Description: @@ -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 @@ -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 @@ -47,6 +47,9 @@ Then - [ ] Bugs or future work cards are identified and created - [ ] Reviewed and approved by Product Owner +#### Blocked By/Blocking + + #### Notes: -