]> jfr.im git - yt-dlp.git/blobdiff - .github/ISSUE_TEMPLATE_tmpl/6_question.yml
[docs] Improve issue templates
[yt-dlp.git] / .github / ISSUE_TEMPLATE_tmpl / 6_question.yml
index a6e5fa80d7e04af7daf4434857ce6f2c1f7eda24..8cb8bba52d70aa91ba8d0a75dc266188742ff2fd 100644 (file)
@@ -2,6 +2,12 @@ name: Ask question
 description: Ask yt-dlp related question
 labels: [question]
 body:
+  - type: markdown
+    attributes:
+      value: |
+        ### Make sure you are **only** asking a question and not reporting a bug or requesting a feature.
+        If your question contains "isn't working" or "can you add", this is most likely the wrong template.
+        If you are in doubt whether this is the right template, **use another template**!
   - type: checkboxes
     id: checklist
     attributes:
@@ -9,22 +15,22 @@ body:
       description: |
         Carefully read and work through this check list in order to prevent the most common mistakes and misuse of yt-dlp:
       options:
-        - label: I'm asking a question and not reporting a bug/feature request
+        - label: I'm asking a question and **not** reporting a bug or requesting a feature
           required: true
         - label: I've looked through the [README](https://github.com/yt-dlp/yt-dlp#readme)
           required: true
-        - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue)
+        - label: I've verified that I'm running yt-dlp version **%(version)s** ([update instructions](https://github.com/yt-dlp/yt-dlp#update)) or later (specify commit)
           required: true
-        - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar questions including closed ones
+        - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar questions **including closed ones**. DO NOT post duplicates
+          required: true
+        - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue)
           required: true
   - type: textarea
     id: question
     attributes:
-      label: Question
-      description: |
-        Ask your question in an arbitrary form.
-        Please make sure it's worded well enough to be understood, see [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient).
-        Provide any additional information and as much context and examples as possible
-      placeholder: WRITE QUESTION HERE
+      label: Please make sure the question is worded well enough to be understood
+      description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient)
+      placeholder: Provide any additional information and as much context and examples as possible
     validations:
       required: true
+  %(verbose_optional)s