]> git.openstreetmap.org Git - rails.git/commitdiff
Add cause to feature request issue template
authorrugk <rugk+git@posteo.de>
Sun, 15 May 2022 23:32:02 +0000 (01:32 +0200)
committerGitHub <noreply@github.com>
Sun, 15 May 2022 23:32:02 +0000 (01:32 +0200)
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

index e556dfa721060aeed0ea95b38420bdc1dc58e7bc..0931ca0d60da2b2abc20406e0d4676a7968a1491 100644 (file)
@@ -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