From 32a33fb535cbc4c3f66f5af1f2bccc8b777b52cd Mon Sep 17 00:00:00 2001 From: Sarah Rudder Date: Thu, 25 Jan 2024 13:11:59 -0600 Subject: [PATCH 1/5] Update Issue Template --- .github/ISSUE_TEMPLATE/issue.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue.md b/.github/ISSUE_TEMPLATE/issue.md index 555aae2b..50c2b316 100644 --- a/.github/ISSUE_TEMPLATE/issue.md +++ b/.github/ISSUE_TEMPLATE/issue.md @@ -1,18 +1,14 @@ --- -name: Issue +name: Issue for Dashboard team about: Suggest a new issue for this project -title: "[short phrase distinguishing this from other Issues]" -labels: '' +title: "[Briefly describe the issue/bug]" +labels: 'squad-dashboard' assignees: '' --- -Short description explaining the high-level reason for the new issue. +## Expected Behavior -## Notes +## Actual Behavior -- Additional details, technical information, resource links, and implementation notes -- Excerpt and link to any relevant slack discussions +## Steps to reproduce the behavior -## Acceptance Criteria - -- [ ] Determine next steps and acceptance criteria From b0973f63da357aaebbfecd4fd4431123dbc80b9d Mon Sep 17 00:00:00 2001 From: Sarah Rudder Date: Thu, 25 Jan 2024 13:17:15 -0600 Subject: [PATCH 2/5] Update story.md --- .github/ISSUE_TEMPLATE/story.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/story.md b/.github/ISSUE_TEMPLATE/story.md index 233a15a9..d3a12e09 100644 --- a/.github/ISSUE_TEMPLATE/story.md +++ b/.github/ISSUE_TEMPLATE/story.md @@ -1,13 +1,13 @@ --- name: Story about: Suggest a new story for this project -title: "[short phrase distinguishing this from other Stories]" -labels: '' +title: "[Briefly summarize user story]" +labels: 'squad-dashboard' assignees: '' --- -In order to [reason/outcome/goal], [someone or "we"] want [a specific change in product implementation/behavior] +As a \, I want to \ so that \. ## Acceptance Criteria * [ ] GIVEN [a precondition] \ @@ -22,7 +22,8 @@ In order to [reason/outcome/goal], [someone or "we"] want [a specific change in ## Security considerations [note any potential changes to security boundaries, practices, documentation, risk that arise directly from this story] -## Implementation sketch +## Research resources [links to background notes, sketches, and/or relevant documentation * [ ] [first thing to do] * [ ] [another thing to do] + From 2a22554119587d786b2c3c2b0fc13a14bb57a1a3 Mon Sep 17 00:00:00 2001 From: Sarah Rudder Date: Thu, 25 Jan 2024 13:17:39 -0600 Subject: [PATCH 3/5] fix newline --- .github/ISSUE_TEMPLATE/story.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/story.md b/.github/ISSUE_TEMPLATE/story.md index d3a12e09..297d3045 100644 --- a/.github/ISSUE_TEMPLATE/story.md +++ b/.github/ISSUE_TEMPLATE/story.md @@ -11,11 +11,11 @@ As a \, I want to \ so that \. ## Acceptance Criteria * [ ] GIVEN [a precondition] \ - AND [another precondition] + AND [another precondition] \ WHEN [test step] \ AND [test step] \ THEN [verification step] \ - AND [verification step] + AND [verification step] \ --- From d443e7875d77044cb112e317eede7ea965670168 Mon Sep 17 00:00:00 2001 From: Sarah Rudder Date: Thu, 25 Jan 2024 13:18:37 -0600 Subject: [PATCH 4/5] Update story.md --- .github/ISSUE_TEMPLATE/story.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/story.md b/.github/ISSUE_TEMPLATE/story.md index 297d3045..5f9c98cd 100644 --- a/.github/ISSUE_TEMPLATE/story.md +++ b/.github/ISSUE_TEMPLATE/story.md @@ -10,13 +10,8 @@ assignees: '' As a \, I want to \ so that \. ## Acceptance Criteria -* [ ] GIVEN [a precondition] \ - AND [another precondition] \ - WHEN [test step] \ - AND [test step] \ - THEN [verification step] \ - AND [verification step] \ - +* [Requirement 1] +* [Requirement 2] --- ## Security considerations From b401d524f13cdd4e2fffadff865f5bd9d47b5b7e Mon Sep 17 00:00:00 2001 From: Eleni Chappen Date: Fri, 26 Jan 2024 10:08:31 -0600 Subject: [PATCH 5/5] convert GH issue markdown templates to yaml to include GH project and label automatically --- .github/ISSUE_TEMPLATE/bug.yaml | 56 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/issue.md | 14 -------- .github/ISSUE_TEMPLATE/request.yml | 50 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/story.md | 24 ------------- .github/ISSUE_TEMPLATE/story.yaml | 47 +++++++++++++++++++++++++ 5 files changed, 153 insertions(+), 38 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml delete mode 100644 .github/ISSUE_TEMPLATE/issue.md create mode 100644 .github/ISSUE_TEMPLATE/request.yml delete mode 100644 .github/ISSUE_TEMPLATE/story.md create mode 100644 .github/ISSUE_TEMPLATE/story.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 00000000..71bcea07 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -0,0 +1,56 @@ +name: Bug for dashboard team +description: Report a new bug +title: "[Briefly describe the bug]" +labels: ["squad-dashboard"] +projects: ["cloud-gov/27"] +assignees: '' +body: + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: '' + validations: + required: false + - type: textarea + id: expected + attributes: + label: Expected behavior + description: What did you expect to happen? + placeholder: Tell us what you expected + value: "I was expecting:" + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual behavior + description: What happened instead? + placeholder: Tell us what you saw + value: "This happened instead:" + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: textarea + id: notes + attributes: + label: Notes + description: Anything else we should know? + placeholder: provide any additional context here + value: "More context:" diff --git a/.github/ISSUE_TEMPLATE/issue.md b/.github/ISSUE_TEMPLATE/issue.md deleted file mode 100644 index 50c2b316..00000000 --- a/.github/ISSUE_TEMPLATE/issue.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Issue for Dashboard team -about: Suggest a new issue for this project -title: "[Briefly describe the issue/bug]" -labels: 'squad-dashboard' -assignees: '' - ---- -## Expected Behavior - -## Actual Behavior - -## Steps to reproduce the behavior - diff --git a/.github/ISSUE_TEMPLATE/request.yml b/.github/ISSUE_TEMPLATE/request.yml new file mode 100644 index 00000000..da01214c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/request.yml @@ -0,0 +1,50 @@ +name: Request for dashboard team +description: Submit a new request for the project +title: "[Briefly describe the request]" +labels: ["squad-dashboard"] +projects: ["cloud-gov/27"] +assignees: '' +body: + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: '' + validations: + required: false + - type: textarea + id: problem + attributes: + label: Problem + description: Describe the problem + placeholder: Tell us here + value: "I'm noticing:" + validations: + required: true + - type: textarea + id: expected + attributes: + label: Request + description: What would you like to see? + placeholder: Tell us what you want + value: "I would like instead:" + validations: + required: true + - type: textarea + id: acceptance + attributes: + label: Acceptance Criteria + description: How will we know when we're done? + placeholder: Tell us here + value: "We will know we are done when:" + validations: + required: true + - type: textarea + id: notes + attributes: + label: Notes + description: Anything else we should know? + placeholder: provide any additional context here + value: "More context:" + diff --git a/.github/ISSUE_TEMPLATE/story.md b/.github/ISSUE_TEMPLATE/story.md deleted file mode 100644 index 5f9c98cd..00000000 --- a/.github/ISSUE_TEMPLATE/story.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Story -about: Suggest a new story for this project -title: "[Briefly summarize user story]" -labels: 'squad-dashboard' -assignees: '' - ---- - -As a \, I want to \ so that \. - -## Acceptance Criteria -* [Requirement 1] -* [Requirement 2] ---- - -## Security considerations -[note any potential changes to security boundaries, practices, documentation, risk that arise directly from this story] - -## Research resources -[links to background notes, sketches, and/or relevant documentation -* [ ] [first thing to do] -* [ ] [another thing to do] - diff --git a/.github/ISSUE_TEMPLATE/story.yaml b/.github/ISSUE_TEMPLATE/story.yaml new file mode 100644 index 00000000..3ea0352e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/story.yaml @@ -0,0 +1,47 @@ +name: Story for dashboard team +description: Suggest a new story for this project +title: "[Briefly summarize user story]" +labels: ["squad-dashboard"] +projects: ["cloud-gov/27"] +assignees: '' +body: + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: '' + validations: + required: false + - type: textarea + id: story + attributes: + label: Story + description: Describe the story + placeholder: Tell us here in AAU terms + value: "As a \, I want to \ so that \." + validations: + required: true + - type: textarea + id: acceptance + attributes: + label: Acceptance Criteria + description: How will we know when we're done? + placeholder: Tell us here + value: "We will know we are done when:" + validations: + required: true + - type: textarea + id: security + attributes: + label: Security considerations + description: note any potential changes to security boundaries, practices, documentation, risk that arise directly from this story + placeholder: '' + value: '' + - type: textarea + id: resources + attributes: + label: Additional resources + description: Add any links to background notes, sketches, and/or relevant documentation + placeholder: '' + value: ''