From 6c81639855db0ec795a44cf4e9d8a0bfae152a28 Mon Sep 17 00:00:00 2001 From: Cameron Dixon Date: Mon, 2 Oct 2023 21:50:33 -0400 Subject: [PATCH 1/8] Update issue-default.yml --- .github/ISSUE_TEMPLATE/issue-default.yml | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index 35c816e35..afbf0e3e3 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -6,29 +6,27 @@ body: id: 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 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 – links and images welcome! Share desired outcomes or potential next steps. 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 checklist." - type: textarea id: issue-links attributes: - label: Issue Links + label: Other issues description: | - What other issues does this story relate to and how? + Add the issue number of other issues this relates to and how. Example: - - 🚧 Blocked by: #123 - - 🔄 Relates to: #234 \ No newline at end of file + - 🚧 Blocks/is blocked by #123 + - 🔄 Relates to #234 From f221ef1b361ca9a4bd052090551f271aaedd4f36 Mon Sep 17 00:00:00 2001 From: Cameron Dixon Date: Thu, 5 Oct 2023 10:14:30 -0400 Subject: [PATCH 2/8] respond to feedback and add placeholder/value attributes --- .github/ISSUE_TEMPLATE/issue-default.yml | 28 ++++++++++++++---------- 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index afbf0e3e3..2665509f3 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -1,32 +1,36 @@ 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: | > Titles should be short, descriptive, and compelling. - type: textarea - id: issue + id: issue-description attributes: label: Issue description and context description: | - 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 – links and images welcome! Share desired outcomes or potential next steps. + 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 discussion) are welcome. validations: required: true - type: textarea id: acceptance-criteria attributes: 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 checklist." + 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." + value: - [ ] - type: textarea - id: issue-links + id: links-to-other-issues attributes: - label: Other issues + label: Links to other issues description: | - Add the issue number of other issues this relates to and how. - - Example: - - 🚧 Blocks/is blocked by #123 - - 🔄 Relates to #234 + Add the issue number of other issues this relates to and how (blocks, is blocked by, relates to). + placeholder: relates to #123 + - type: textarea + id: note + attributes: + label: Note + description: | + We may edit this issue's text to document our understanding and clarify the product work. From d394a08850180785f07bbafe51fb5a3b7e867733 Mon Sep 17 00:00:00 2001 From: Cameron Dixon Date: Thu, 5 Oct 2023 10:18:03 -0400 Subject: [PATCH 3/8] replace value/task list formatting with placeholder --- .github/ISSUE_TEMPLATE/issue-default.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index 2665509f3..01158deda 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -20,7 +20,7 @@ body: attributes: 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." - value: - [ ] + placeholder: - [ ] - type: textarea id: links-to-other-issues attributes: From bfda399e3dc2028c1b9affa46cfd059eb4efc32a Mon Sep 17 00:00:00 2001 From: Cameron Dixon Date: Thu, 5 Oct 2023 10:18:59 -0400 Subject: [PATCH 4/8] remove attempt to placeholder task list formatting --- .github/ISSUE_TEMPLATE/issue-default.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index 01158deda..645ed4120 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -20,7 +20,6 @@ body: attributes: 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: - [ ] - type: textarea id: links-to-other-issues attributes: From 04d6a1204a08e2f3b057304d38d608b8a74809c8 Mon Sep 17 00:00:00 2001 From: Cameron Dixon Date: Thu, 5 Oct 2023 10:25:51 -0400 Subject: [PATCH 5/8] fix note with markdown type instead of textarea --- .github/ISSUE_TEMPLATE/issue-default.yml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index 645ed4120..a71623d4f 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -26,10 +26,9 @@ body: label: Links to other issues description: | Add the issue number of other issues this relates to and how (blocks, is blocked by, relates to). - placeholder: relates to #123 - - type: textarea + placeholder: Relates to... + - type: markdown id: note attributes: - label: Note - description: | - We may edit this issue's text to document our understanding and clarify the product work. + value: | + > We may edit this issue's text to document our understanding and clarify the product work. From bf5d254b8384903439e71bbd31e11bf8ca8a773e Mon Sep 17 00:00:00 2001 From: Cameron Dixon Date: Fri, 6 Oct 2023 09:12:16 -0400 Subject: [PATCH 6/8] re-add emoji --- .github/ISSUE_TEMPLATE/issue-default.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index a71623d4f..5ca076233 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -12,7 +12,7 @@ body: attributes: label: Issue description and context description: | - 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 discussion) are welcome. + 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 @@ -25,8 +25,8 @@ body: attributes: label: Links to other issues description: | - Add the issue number of other issues this relates to and how (blocks, is blocked by, relates to). - placeholder: Relates to... + "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: From 83844fc2f8001e65c62ef90ea76dd52ac3bad2f5 Mon Sep 17 00:00:00 2001 From: Cameron Dixon Date: Fri, 6 Oct 2023 09:13:12 -0400 Subject: [PATCH 7/8] remove quotes --- .github/ISSUE_TEMPLATE/issue-default.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index 5ca076233..943aa1509 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -25,7 +25,7 @@ body: attributes: label: Links to other issues description: | - "Add the issue #number of other issues this relates to and how (e.g., 🚧 Blocks, ⛔️ Is blocked by, 🔄 Relates to)." + 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 From bf622b5e50c227fba9559c169b43cfb9fbe9ac37 Mon Sep 17 00:00:00 2001 From: Cameron Dixon Date: Fri, 6 Oct 2023 09:19:28 -0400 Subject: [PATCH 8/8] another attempt at placeholder text with tasks --- .github/ISSUE_TEMPLATE/issue-default.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index 943aa1509..27ec10415 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -20,6 +20,7 @@ body: attributes: 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: links-to-other-issues attributes: