Skip to content

Commit

Permalink
Merge pull request #3218 from cisagov/update-issue
Browse files Browse the repository at this point in the history
Add story info to issue template
  • Loading branch information
h-m-f-t authored Dec 11, 2024
2 parents c0f0cf8 + c69cfd7 commit ab59b7a
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/issue-default.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
name: Issue
description: Describe an idea, feature, content, or non-bug finding
name: Issue / story
description: Describe an idea, problem, feature, or story. (Report bugs in the Bug template.)

body:
- type: markdown
id: title-help
attributes:
value: |
> Titles should be short, descriptive, and compelling. Use sentence case.
> Titles should be short, descriptive, and compelling. Use sentence case: don't capitalize words unnecessarily.
- type: textarea
id: issue-description
attributes:
label: Issue 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).
Describe the issue so that someone who wasn't present for its discovery can understand why it matters. For stories, use the user story format (e.g., As a user, I want, so that). 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:
required: true
- type: textarea
Expand All @@ -31,7 +31,7 @@ body:
attributes:
label: Links to other issues
description: |
"With a `-` to start the line, add issue #numbers this relates to and how (e.g., 🚧 [construction] Blocks, ⛔️ [no_entry] Is blocked by, 🔄 [arrows_counterclockwise] Relates to)."
"Use a dash (`-`) to start the line. Add an issue by typing "`#`" then the issue number. Add information to describe any dependancies, blockers, etc. (e.g., 🚧 [construction] Blocks, ⛔️ [no_entry] Is blocked by, 🔄 [arrows_counterclockwise] Relates to). If this is a parent issue, use sub-issues instead of linking other issues here."
placeholder: "- 🔄 Relates to..."
- type: markdown
id: note
Expand Down

0 comments on commit ab59b7a

Please sign in to comment.