From c69cfd72f3d40d02e893a257b9ae95205029f77b Mon Sep 17 00:00:00 2001 From: Cameron Dixon Date: Wed, 11 Dec 2024 16:17:46 -0500 Subject: [PATCH] Update issue-default.yml --- .github/ISSUE_TEMPLATE/issue-default.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index 254078246..292d0ebec 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -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 @@ -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