Refine GitHub Issue templates (#28345)

Peter Tripp created

Make various improvements to our github issue templates.

- Adjust line lengths to not wrap in constrained new issue view (85
cols) not just full screen view (95 columns)
- Remove reference to drag/drop logs to upload (recently multiple issues
with dead upload links)
- Cleanup list view

Release Notes:

- N/A

Change summary

.github/ISSUE_TEMPLATE/01_bug_agent.yml            | 36 +++++++++++
.github/ISSUE_TEMPLATE/01_git_bug_report.yml       | 51 ----------------
.github/ISSUE_TEMPLATE/02_agent_bug_report.yml     | 51 ----------------
.github/ISSUE_TEMPLATE/02_bug_edit_predictions.yml | 29 ++------
.github/ISSUE_TEMPLATE/03_bug_git.yml              | 35 ++++++++++
.github/ISSUE_TEMPLATE/10_bug_report.yml           | 47 +++++++-------
.github/ISSUE_TEMPLATE/11_crash_report.yml         | 14 ++-
.github/ISSUE_TEMPLATE/config.yml                  |  5 -
8 files changed, 110 insertions(+), 158 deletions(-)

Detailed changes

.github/ISSUE_TEMPLATE/01_bug_agent.yml 🔗

@@ -0,0 +1,36 @@
+name: Bug Report (Agent Panel)
+description: Zed Agent Panel Bugs
+type: "Bug"
+labels: ["agent", "ai"]
+title: "Agent Panel: <a short description of the Agent Panel bug>"
+body:
+  - type: textarea
+    attributes:
+      label: Summary
+      description: Describe the bug with a one line summary, and provide detailed reproduction steps
+      value: |
+        <!-- Please insert a one line summary of the issue below -->
+        SUMMARY_SENTENCE_HERE
+
+        ### Description
+        <!--  Describe with sufficient detail to reproduce from a clean Zed install. -->
+        <!--  Please include the LLM provider and model name you are using -->
+        Steps to trigger the problem:
+        1.
+        2.
+        3.
+
+        Actual Behavior:
+        Expected Behavior:
+    validations:
+      required: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Zed Version and System Specs
+      description: 'Open Zed, and in the command palette select "zed: Copy System Specs Into Clipboard"'
+      placeholder: |
+        Output of "zed: Copy System Specs Into Clipboard"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/01_git_bug_report.yml 🔗

@@ -1,51 +0,0 @@
-name: Git Bug Report
-description: There is a bug related to Git features in Zed
-type: "Bug"
-labels: ["git"]
-title: "Git: <a short description of the Git bug>"
-body:
-  - type: textarea
-    attributes:
-      label: Summary
-      description: Describe the bug with a one line summary, and provide detailed reproduction steps
-      value: |
-        <!-- Please insert a one line summary of the issue below -->
-
-        <!-- Include all steps necessary to reproduce from a clean Zed installation. Be verbose -->
-        Steps to trigger the problem:
-        1.
-        2.
-        3.
-
-        Actual Behavior:
-
-        Expected Behavior:
-
-    validations:
-      required: true
-  - type: textarea
-    id: environment
-    attributes:
-      label: Zed Version and System Specs
-      description: 'Open Zed, and in the command palette select "zed: Copy System Specs Into Clipboard"'
-      placeholder: |
-        Output of "zed: Copy System Specs Into Clipboard"
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: If applicable, attach your `~/Library/Logs/Zed/Zed.log` file to this issue.
-      description: |
-        macOS: `~/Library/Logs/Zed/Zed.log`
-        Linux: `~/.local/share/zed/logs/Zed.log` or $XDG_DATA_HOME
-        If you only need the most recent lines, you can run the `zed: open log` command palette action to see the last 1000.
-      value: |
-        <details><summary>Zed.log</summary>
-
-        <!-- Click below this line and paste or drag-and-drop your log-->
-        ```
-
-        ```
-        <!-- Click above this line and paste or drag-and-drop your log--></details>
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/02_agent_bug_report.yml 🔗

@@ -1,51 +0,0 @@
-name: Agent Panel Bug Report
-description: There is a bug related to the Agent Panel in Zed
-type: "Bug"
-labels: ["agent", "ai"]
-title: "Agent Panel: <a short description of the Agent Panel bug>"
-body:
-  - type: textarea
-    attributes:
-      label: Summary
-      description: Describe the bug with a one line summary, and provide detailed reproduction steps
-      value: |
-        <!-- Please insert a one line summary of the issue below -->
-
-        <!-- Include all steps necessary to reproduce from a clean Zed installation. Be verbose -->
-        Steps to trigger the problem:
-        1.
-        2.
-        3.
-
-        Actual Behavior:
-
-        Expected Behavior:
-
-    validations:
-      required: true
-  - type: textarea
-    id: environment
-    attributes:
-      label: Zed Version and System Specs
-      description: 'Open Zed, and in the command palette select "zed: Copy System Specs Into Clipboard"'
-      placeholder: |
-        Output of "zed: Copy System Specs Into Clipboard"
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: If applicable, attach your `~/Library/Logs/Zed/Zed.log` file to this issue.
-      description: |
-        macOS: `~/Library/Logs/Zed/Zed.log`
-        Linux: `~/.local/share/zed/logs/Zed.log` or $XDG_DATA_HOME
-        If you only need the most recent lines, you can run the `zed: open log` command palette action to see the last 1000.
-      value: |
-        <details><summary>Zed.log</summary>
-
-        <!-- Click below this line and paste or drag-and-drop your log-->
-        ```
-
-        ```
-        <!-- Click above this line and paste or drag-and-drop your log--></details>
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/00_edit_predictions_bug_report.yml → .github/ISSUE_TEMPLATE/02_bug_edit_predictions.yml 🔗

@@ -1,5 +1,5 @@
-name: Edit Predictions Bug Report
-description: There is a bug related to Edit Predictions in Zed
+name: Bug Report (Edit Predictions)
+description: Zed Edit Predictions bugs
 type: "Bug"
 labels: ["ai", "inline completion", "zeta"]
 title: "Edit Predictions: <a short description of the Edit Prediction bug>"
@@ -10,19 +10,21 @@ body:
       description: Describe the bug with a one line summary, and provide detailed reproduction steps
       value: |
         <!-- Please insert a one line summary of the issue below -->
+        SUMMARY_SENTENCE_HERE
 
-        <!-- Include all steps necessary to reproduce from a clean Zed installation. Be verbose -->
+        ### Description
+        <!--  Describe with sufficient detail to reproduce from a clean Zed install. -->
+        <!--  Please include the LLM provider and model name you are using -->
         Steps to trigger the problem:
         1.
         2.
         3.
 
         Actual Behavior:
-
         Expected Behavior:
-
     validations:
       required: true
+
   - type: textarea
     id: environment
     attributes:
@@ -32,20 +34,3 @@ body:
         Output of "zed: Copy System Specs Into Clipboard"
     validations:
       required: true
-  - type: textarea
-    attributes:
-      label: If applicable, attach your `~/Library/Logs/Zed/Zed.log` file to this issue.
-      description: |
-        macOS: `~/Library/Logs/Zed/Zed.log`
-        Linux: `~/.local/share/zed/logs/Zed.log` or $XDG_DATA_HOME
-        If you only need the most recent lines, you can run the `zed: open log` command palette action to see the last 1000.
-      value: |
-        <details><summary>Zed.log</summary>
-
-        <!-- Click below this line and paste or drag-and-drop your log-->
-        ```
-
-        ```
-        <!-- Click above this line and paste or drag-and-drop your log--></details>
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/03_bug_git.yml 🔗

@@ -0,0 +1,35 @@
+name: Bug Report (Git)
+description: Zed Git-Related Bugs
+type: "Bug"
+labels: ["git"]
+title: "Git: <a short description of the Git bug>"
+body:
+  - type: textarea
+    attributes:
+      label: Summary
+      description: Describe the bug with a one line summary, and provide detailed reproduction steps
+      value: |
+        <!-- Please insert a one line summary of the issue below -->
+        SUMMARY_SENTENCE_HERE
+
+        ### Description
+        <!--  Describe with sufficient detail to reproduce from a clean Zed install. -->
+        Steps to trigger the problem:
+        1.
+        2.
+        3.
+
+        Actual Behavior:
+        Expected Behavior:
+
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    attributes:
+      label: Zed Version and System Specs
+      description: 'Open Zed, and in the command palette select "zed: Copy System Specs Into Clipboard"'
+      placeholder: |
+        Output of "zed: Copy System Specs Into Clipboard"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/10_bug_report.yml 🔗

@@ -1,46 +1,44 @@
-name: Bug Report
+name: Bug Report (Other)
 description: |
-  Something is broken in Zed (exclude crashing).
+  Something else is broken in Zed (exclude crashing).
 type: "Bug"
 body:
   - type: textarea
     attributes:
       label: Summary
-      description: Describe the bug with a one line summary, and provide detailed reproduction steps
+      description: Provide a one sentence summary and detailed reproduction steps
       value: |
-        <!-- Please insert a one line summary of the issue below -->
-
+        <!-- Begin your issue with a one sentence summary -->
         SUMMARY_SENTENCE_HERE
 
-        <!-- Be verbose: Include all steps necessary to reproduce from a clean Zed installation. -->
-        <!-- Code snippets are better than images, a repository link that reproduces the issue is ideal. -->
+        ### Description
+        <!--  Describe with sufficient detail to reproduce from a clean Zed install.
+          - Any code must be sufficient to reproduce (include context!)
+          - Code must as text, not just as a screenshot.
+          - Issues with insufficient detail may be summarily closed.
+        -->
 
-        Steps to trigger the problem:
+        Steps to reproduce:
         1.
         2.
         3.
         4.
 
-        Actual Behavior:
-
         Expected Behavior:
+        Actual Behavior:
 
-        <!--
-          Is there anything additional necessary to reproduce this issue?
-            - settings.json, keymap.json, .editorconfig etc?
-            - Does it happen intermittently or only with specific projects / file types?
-            - Have you found a workaround?
-
-          Did you check your Zed.log to see if there is any relevant details there?
-            - When including large items (videos, screenshots, logs, configs) please wrap with:
+        <!-- Before Submitting, did you:
+          1. Include settings.json, keymap.json, .editorconfig if relevant?
+          2. Check your Zed.log for relevant errors? (please include!)
+          3. Click Preview to ensure everything looks right?
+          4. Hide videos, large images and logs in ``` inside collapsible blocks:
 
-          <details><summary>See inside for XXXXYYY</summary>
+        <details><summary>click to expand</summary>
 
-          ```shell
-          code
-          ```
+        ```json
 
-          </details>
+        ```
+        </details>
         -->
 
     validations:
@@ -50,7 +48,8 @@ body:
     id: environment
     attributes:
       label: Zed Version and System Specs
-      description: 'Open Zed, and in the command palette select "zed: Copy System Specs Into Clipboard"'
+      description: |
+        Open Zed, from the command palette select "zed: Copy System Specs Into Clipboard"
       placeholder: |
         Output of "zed: Copy System Specs Into Clipboard"
     validations:

.github/ISSUE_TEMPLATE/11_crash_report.yml 🔗

@@ -5,10 +5,12 @@ body:
   - type: textarea
     attributes:
       label: Summary
-      description: Describe the bug with a one line summary, and provide detailed reproduction steps
+      description: Summarize the issue with detailed reproduction steps
       value: |
-        <!-- Please insert a one line summary of the issue below -->
+        <!-- Begin your issue with a one sentence summary -->
+        SUMMARY_SENTENCE_HERE
 
+        ### Description
         <!-- Include all steps necessary to reproduce from a clean Zed installation. Be verbose -->
         Steps to trigger the problem:
         1.
@@ -16,7 +18,6 @@ body:
         3.
 
         Actual Behavior:
-
         Expected Behavior:
 
     validations:
@@ -40,10 +41,11 @@ body:
       value: |
         <details><summary>Zed.log</summary>
 
-        <!-- Click below this line and paste or drag-and-drop your log-->
-        ```
+        <!-- Paste your log inside the code block. -->
+        ```log
 
         ```
-        <!-- Click above this line and paste or drag-and-drop your log--></details>
+
+        </details>
     validations:
       required: false

.github/ISSUE_TEMPLATE/config.yml 🔗

@@ -4,9 +4,6 @@ contact_links:
   - name: Feature Request
     url: https://github.com/zed-industries/zed/discussions/new/choose
     about: To request a feature, open a new Discussion in one of the appropriate Discussion categories
-  - name: Zed Discussion Forum
-    url: https://github.com/zed-industries/zed/discussions
-    about: A community discussion forum
-  - name: "Zed Discord: #Support Channel"
+  - name: "Zed Discord"
     url: https://zed.dev/community-links
     about: Real-time discussion and user support