Separate additional context from the description

This commit is contained in:
Cameron Dixon 2023-10-20 06:33:11 -04:00 committed by GitHub
parent e6e0c2c416
commit 15ecaa83e7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -10,9 +10,9 @@ body:
- type: textarea - type: textarea
id: issue-description id: issue-description
attributes: attributes:
label: Issue description and context label: Issue description
description: | description: |
Describe the issue so that someone who wasn't present for its discovery can understand 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). Screenshots and links to documents/discussions are welcome. Describe the issue so that someone who wasn't present for its discovery can understand 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).
validations: validations:
required: true required: true
- type: textarea - type: textarea
@ -21,6 +21,11 @@ body:
label: Acceptance criteria 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." 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: "- [ ]" placeholder: "- [ ]"
- type: textarea
id: additional-context
attributes:
label: Additional context
description: "Share any other thoughts, like how this might be implemented or fixed. Screenshots and links to documents/discussions are welcome."
- type: textarea - type: textarea
id: links-to-other-issues id: links-to-other-issues
attributes: attributes:
@ -32,4 +37,5 @@ body:
id: note id: note
attributes: attributes:
value: | value: |
> We may edit this issue's text to document our understanding and clarify the product work. > We may edit the text in this issue to document our understanding and clarify the product work.