From 0e794f2a35571692bd5e13904319a4b1f058cd81 Mon Sep 17 00:00:00 2001 From: Artur Michalek Date: Fri, 20 Dec 2024 17:53:52 +0100 Subject: [PATCH 1/4] Update work item template --- .github/ISSUE_TEMPLATE/work_item.yml | 32 +++++++++++++++++----------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/work_item.yml b/.github/ISSUE_TEMPLATE/work_item.yml index 5de8d547dd..2236f8c8fc 100644 --- a/.github/ISSUE_TEMPLATE/work_item.yml +++ b/.github/ISSUE_TEMPLATE/work_item.yml @@ -1,23 +1,29 @@ name: Work item description: Submit an actionable task body: - - type: dropdown - id: tool-name + - type: textarea + id: current-state attributes: - label: Which components does the task require to be changed? (think hard pls) - multiple: true - options: - - snforge - - sncast - - cairo-profiler - - other (describe below) + label: Current State + description: Describe the current state and state the problem + placeholder: Currently, the `print_a` cheatcode prints `"a"` to stdout. This is problematic because user might want it to be printed on their actual printer. validations: required: true - - type: textarea - id: description + - type: input + id: correct-state attributes: - label: Description - description: Describe the issue here. + label: Correct State + description: Briefly describe the correct state + placeholder: `print_a` should magically detect if user wants to print to stdout or a printer. validations: required: true + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Provide additional context on the desired state. + placeholder: E.g. if we can detect any printers in local network it might indicate that user wants to print to it. + validations: + required: false From 80ee25d5fd1bf583bcfdbac1b0dbb90094dd7da6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Artur=20Micha=C5=82ek?= <52135326+cptartur@users.noreply.github.com> Date: Fri, 10 Jan 2025 10:36:47 +0100 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: ddoktorski <45050160+ddoktorski@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/work_item.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/work_item.yml b/.github/ISSUE_TEMPLATE/work_item.yml index 2236f8c8fc..5dce33a0cc 100644 --- a/.github/ISSUE_TEMPLATE/work_item.yml +++ b/.github/ISSUE_TEMPLATE/work_item.yml @@ -5,15 +5,15 @@ body: id: current-state attributes: label: Current State - description: Describe the current state and state the problem + description: Describe the current state and outline the problem placeholder: Currently, the `print_a` cheatcode prints `"a"` to stdout. This is problematic because user might want it to be printed on their actual printer. validations: required: true - type: input - id: correct-state + id: objective attributes: - label: Correct State + label: Objective description: Briefly describe the correct state placeholder: `print_a` should magically detect if user wants to print to stdout or a printer. validations: From 292c91e46836372db82ecb258efd5f749b200fd0 Mon Sep 17 00:00:00 2001 From: Artur Michalek Date: Fri, 10 Jan 2025 10:37:52 +0100 Subject: [PATCH 3/4] Remove `e.g.` --- .github/ISSUE_TEMPLATE/work_item.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/work_item.yml b/.github/ISSUE_TEMPLATE/work_item.yml index 5dce33a0cc..4d03b16fac 100644 --- a/.github/ISSUE_TEMPLATE/work_item.yml +++ b/.github/ISSUE_TEMPLATE/work_item.yml @@ -24,6 +24,6 @@ body: attributes: label: Additional Context description: Provide additional context on the desired state. - placeholder: E.g. if we can detect any printers in local network it might indicate that user wants to print to it. + placeholder: If we can detect any printers in local network it might indicate that user wants to print to it. validations: required: false From d50e1f8de34f42d562a456a8f031091f2145fb13 Mon Sep 17 00:00:00 2001 From: Artur Michalek Date: Fri, 10 Jan 2025 10:39:29 +0100 Subject: [PATCH 4/4] Fix invalid start of sentence --- .github/ISSUE_TEMPLATE/work_item.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/work_item.yml b/.github/ISSUE_TEMPLATE/work_item.yml index 4d03b16fac..79d5401ed2 100644 --- a/.github/ISSUE_TEMPLATE/work_item.yml +++ b/.github/ISSUE_TEMPLATE/work_item.yml @@ -15,7 +15,7 @@ body: attributes: label: Objective description: Briefly describe the correct state - placeholder: `print_a` should magically detect if user wants to print to stdout or a printer. + placeholder: The `print_a` cheatcode should magically detect if user wants to print to stdout or a printer. validations: required: true