Make the configuration optional in the bug report template

pylint-dev · Jul 25, 2021 · 20b729e · 20b729e
1 parent 0641da3
commit 20b729e
Showing 1 changed file with 19 additions and 13 deletions.
diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
@@ -7,8 +7,7 @@ body:
       value: |
         **Thank you for wanting to report a bug in pylint!**
 
-        ⚠
-        Please make sure that this issue wasn't already requested, or already implemented in the main branch.
+        ⚠ Please make sure that this issue wasn't already requested, or already implemented in the main branch.
   - type: textarea
     id: what-happened
     attributes:
@@ -24,16 +23,21 @@ body:
         # pylint: disable=missing-docstring,
         <a> = b + 1
         ```
-
-        Using the following configuration pylintrc:
+    validations:
+      required: true
+  - type: textarea
+    id: configuration
+    attributes:
+      label: (Configuration)
+      description:
+        Please provide the part of the configuration that is causing the bug if required
+        (Leave this part blank if the configuration is not relevant)
+      value: |
+        Using the following configuration:
         ```ini
-        # Please remove configuration unrelated to the bug
-
-        [MESSAGES CONTROL]
-        enable=use-symbolic-message-instead,
         ```
     validations:
-      required: true
+      required: false
   - type: textarea
     id: current-behavior
     attributes:
@@ -58,8 +62,10 @@ body:
   - type: textarea
     id: python-interpreter
     attributes:
-      label: "Output of 'pylint --version'"
-      description: Please copy and paste the result
+      label: Version affected
+      description:
+        Please copy and paste the result of 'pylint --version' or specify the range of
+        version affected
       placeholder: |
         pylint 2.9.6
         astroid 2.6.5
@@ -68,14 +74,14 @@ body:
       render: shell
   - type: textarea
     attributes:
-      label: OS / Environment
+      label: (OS / Environment)
       description: >-
         Provide all relevant information below, e.g. OS version, terminal etc.
       placeholder: Fedora 33, Cygwin, etc.
   - type: textarea
     id: additional-deps
     attributes:
-      label: Additional dependencies ?
+      label: (Additional dependencies)
       description: If applicable ie, if we can't reproduce without it
       placeholder: |
         Additional dependencies: