Merge pull request #694 from cisagov/issue-template-updates

Update issue templates with gathered feedback
This commit is contained in:
Mohammad Minaie 2023-06-08 13:45:31 -04:00 committed by GitHub
commit 7e589a3370
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 15 deletions

View file

@ -1,6 +1,6 @@
name: Bug
description: Report a bug
title: "[Bug]: "
description: Report a bug or problem with the application
title: ""
labels: ["bug"]
body:
@ -56,4 +56,14 @@ body:
id: additional-context
attributes:
label: Additional Context (optional)
description: "Please include additional references, screenshots, documentation, etc. that are relevant"
description: "Please include additional references (screenshots, design links, documentation, etc.) that are relevant"
- type: textarea
id: issue-links
attributes:
label: Issue Links (optional)
description: |
What other issues does this story relate to and how?
Example:
- 🚧 Blocked by: #123
- 🔄 Relates to: #234

View file

@ -1,6 +1,6 @@
name: User Story
name: Story
description: Capture actionable sprint work
title: "[Story]: "
title: ""
labels: ["story"]
body:
@ -13,13 +13,13 @@ body:
- type: textarea
id: story
attributes:
label: User Story
label: Story
description: |
Please add the "as a, I want, so that" details that describe the user story.
Please add the "as a, I want, so that" details that describe the story.
If more than one "as a, I want, so that" describes the story, add multiple.
Example:
As an administrator
As an analyst
I want the ability to approve a domain application
so that a request can be fulfilled and a new .gov domain can be provisioned
value: |
@ -33,23 +33,23 @@ body:
attributes:
label: Acceptance Criteria
description: |
Please add the acceptance criteria using one or more "given, when, then" formulae
Please add the acceptance criteria that best describe the desired outcomes when this work is completed
Example:
Given that I am an administrator who has finished reviewing a domain application
- Application sends an email when analysts approve domain requests
- Domain application status is "approved"
Example ("given, when, then" format):
Given that I am an analyst who has finished reviewing a domain application
When I click to approve a domain application
Then the domain provisioning process should be initiated, and the applicant should receive an email update.
value: |
Given
When
Then
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context (optional)
description: "Please include additional references, screenshots, documentation, etc. that are relevant"
description: "Please include additional references (screenshots, design links, documentation, etc.) that are relevant"
- type: textarea
id: issue-links
attributes: