mirror of
https://github.com/cisagov/manage.get.gov.git
synced 2025-07-25 03:58:39 +02:00
Merge pull request #1113 from cisagov/h-m-f-t-patch-1
Update issue template to add A/C and clarity
This commit is contained in:
commit
30cba83e8e
1 changed files with 19 additions and 18 deletions
37
.github/ISSUE_TEMPLATE/issue-default.yml
vendored
37
.github/ISSUE_TEMPLATE/issue-default.yml
vendored
|
@ -1,34 +1,35 @@
|
|||
name: Issue
|
||||
description: Capture uncategorized work or content
|
||||
description: Describe an idea, feature, content, or non-bug finding
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
id: help
|
||||
id: title-help
|
||||
attributes:
|
||||
value: |
|
||||
> **Note**
|
||||
> GitHub Issues use [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for formatting.
|
||||
> Titles should be short, descriptive, and compelling.
|
||||
- type: textarea
|
||||
id: issue
|
||||
id: issue-description
|
||||
attributes:
|
||||
label: Issue Description
|
||||
label: Issue description and context
|
||||
description: |
|
||||
Describe the issue you are adding or content you are suggesting.
|
||||
Share any next steps that should be taken our outcomes that would be beneficial.
|
||||
Describe the issue so that someone who wasn't present for its discovery can understand the problem and why it matters. Use full sentences, plain language, and good [formatting](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). Share desired outcomes or potential next steps. Images or links to other content/context (like documents or Slack discussions) are welcome.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
id: acceptance-criteria
|
||||
attributes:
|
||||
label: Additional Context (optional)
|
||||
description: "Include additional references (screenshots, design links, documentation, etc.) that are relevant"
|
||||
label: Acceptance criteria
|
||||
description: "If known, share 1-3 statements that would need to be true for this issue to be considered resolved. Use a [task list](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists#creating-task-lists) if appropriate."
|
||||
placeholder: "- [ ] The button does the thing."
|
||||
- type: textarea
|
||||
id: issue-links
|
||||
id: links-to-other-issues
|
||||
attributes:
|
||||
label: Issue Links
|
||||
label: Links to other issues
|
||||
description: |
|
||||
What other issues does this story relate to and how?
|
||||
|
||||
Example:
|
||||
- 🚧 Blocked by: #123
|
||||
- 🔄 Relates to: #234
|
||||
Add the issue #number of other issues this relates to and how (e.g., 🚧 Blocks, ⛔️ Is blocked by, 🔄 Relates to).
|
||||
placeholder: 🔄 Relates to...
|
||||
- type: markdown
|
||||
id: note
|
||||
attributes:
|
||||
value: |
|
||||
> We may edit this issue's text to document our understanding and clarify the product work.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue