chore: improve bug report template

privatenumber · Feb 10, 2023 · bb00e1b · bb00e1b
1 parent 6999a7f
commit bb00e1b
Showing 1 changed file with 17 additions and 10 deletions.
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml
@@ -26,16 +26,18 @@ body:
     attributes:
       label: Reproduction
       description: |
-        How can we reproduce the issue? When an issue is immediately reproducible, others can start debugging instead of following-up with questions.
-      placeholder: |
-        <!--
-          Provide one of the following:
-            1. A code-snippet that reproduces the issue
-            2. A reproduction repository that reproduces the issue
-            3. A pull request with a failing test-case
+        Provide a minimal reproduction in one of the following forms:
+          1. Small code-snippet (no more than one) we can copy-paste. **No dependencies allowed.**
+          2. Link to a repository containing minimal reproduction. **Dependencies allowed.**
+            - No more than 5 files. Delete irrelevant files (e.g. `LICENSE`, `.npmrc`, `.github`).
+            - Set the command to run in the `package.json` script `start`
+            - For a starter template, [fork this template on StackBlitz](https://stackblitz.com/edit/node-huzszn?file=index.ts)
+            - 👉 **Tip:** The _smaller_ the reproduction, the _faster_ we can debug and resolve your issue
+              - Remove all unnecessary files, code, & dependencies. This is the first step of debugging so doing this will save us work.
+              - If possible, convert TypeScript to plain JavaScript to eliminate the possibility of it being a TS bug
 
-          Please remove as much irrelevant code to make it easier for others to read and debug.
-        -->
+        ⚠️ If a _minimal_ reproduction is not provided, the issue will be closed
+      placeholder: 👆 Your issue will be CLOSED if it doesn't follow the instructions above.
     validations:
       required: true
   - type: dropdown
@@ -52,7 +54,12 @@ body:
     attributes:
       label: Environment
       description: |
-        Describe the environment the issue is happening in. This information is used to for reproduction and debugging. Run and paste the output of: `npx envinfo --system --npmPackages webpack,esbuild-loader --binaries`.
+        Run and paste the output of:
+        ```
+        npx envinfo --system --npmPackages webpack,esbuild-loader --binaries
+        ```
+        
+        This information is used to for reproduction and debugging.
       placeholder: |
         System:
           OS: