From 8573b6efd52ac9c8db896079ee02f699403d5130 Mon Sep 17 00:00:00 2001 From: rugk Date: Mon, 16 May 2022 01:32:02 +0200 Subject: [PATCH] Add cause to feature request issue template MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit When writing https://github.com/openstreetmap/openstreetmap-website/issues/3551 I noticed that your template is somewhat problematic. What users really should write is how/why they have the feature request they want, i.e. what (problem) is “behind” a feature request. Similar to how user stories should always go like ”I as a [who] want [what], because [why]”, here the “why” aspect was missing. The “Description” does not really tangle that, it only tangles _what_ the user wants. Screenshots may also be better inline inside of a text description, but I see you want to nudge the user to add screenshots or mockups, so that's fine IMHO. --- .github/ISSUE_TEMPLATE/feature.yml | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index e556dfa72..0931ca0d6 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -4,6 +4,14 @@ description: You want to request a feature, share an idea or have a question. # labels: # assignees: body: + - type: textarea + id: idea + attributes: + label: Problem + description: Please describe problem or use case that is the cause for your feature request or idea. + placeholder: + validations: + required: false - type: textarea id: idea attributes: @@ -15,7 +23,7 @@ body: - type: textarea attributes: label: Screenshots - description: Please add screenshots if they can help us understand your request/idea/question. + description: Please add screenshots or mockups if they can help us understand your request/idea/question. placeholder: validations: required: false -- 2.39.5