New GitHub Issue Templates (#23745)

Co-authored-by: Joseph T. Lyons <joseph@zed.dev> Co-authored-by: Conrad Irwin <conrad@zed.dev>
2025-01-27 17:38:29 -05:00 · 2025-01-27 17:38:29 -05:00 · 82b81ed6d6
commit 82b81ed6d6
parent 23b92e3057
4 changed files with 56 additions and 91 deletions
--- a/.github/ISSUE_TEMPLATE/0_feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/0_feature_request.yml
@ -1,34 +1,14 @@
 name: Feature Request
 description: "Tip: open this issue template from within Zed with the `request feature` command palette action"
-labels: ["admin read", "triage", "enhancement"]
+type: "Feature"
 body:
-  - type: checkboxes
-    attributes:
-      label: Check for existing issues
-      description: Check the backlog of issues to reduce the chances of creating duplicates; if an issue already exists, place a `+1` (👍) on it.
-      options:
-        - label: Completed
-          required: true
  - type: textarea
    attributes:
      label: Describe the feature
      description: A clear and concise description of what you want to happen.
-    validations:
-      required: true
-  - type: textarea
-    id: environment
-    attributes:
-      label: Zed Version and System Specs
-      description: Zed version, release channel, architecture (x86_64 or aarch64), OS (macOS version / Linux distro and version) and RAM amount.
-      placeholder: |
-        <!-- In Zed run `copy system specs into clipboard` from the Zed command palette and paste here. -->
-        <!-- Alternatively spawn `request feature` and this field will be autopopulated -->
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: |
-        If applicable, add mockups / screenshots to help present your vision of the feature
-      description: Drag images into the text input below
-    validations:
-      required: false
+      value: |
+        Summary:
+          *
+
+        Screenshots:
+          <!-- drag files here -->
--- a/.github/ISSUE_TEMPLATE/1_bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/1_bug_report.yml
@ -1,54 +1,36 @@
 name: Bug Report
 description: |
-  Use this template for **non-crash-related** bug reports.
-  Tip: open this issue template from within Zed with the `file bug report` command palette action.
-labels: ["admin read", "triage", "bug"]
+  Something is broken in Zed (exclude crashing).
+type: "Bug"
 body:
-  - type: checkboxes
-    attributes:
-      label: Check for existing issues
-      description: Check the backlog of issues to reduce the chances of creating duplicates; if an issue already exists, place a `+1` (👍) on it.
-      options:
-        - label: Completed
-          required: true
  - type: textarea
    attributes:
      label: Describe the bug / provide steps to reproduce it
-      description: A clear and concise description of what the bug is.
+      description: A one line summary, and detailed reproduction steps
+      value: |
+        Summary:
+
+        <!-- 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: Zed version, release channel, architecture (x86_64 or aarch64), OS (macOS version / Linux distro and version) and RAM amount.
+      description: 'Open Zed, and in the command palette select "zed: Copy System Specs Into Clipboard"'
      placeholder: |
-        <!-- In Zed run `copy system specs into clipboard` from the Zed command palette and paste here. -->
-        <!-- Alternatively spawn `file bug report` and this field will be autopopulated -->
-        <!-- If Zed won't launch, include the equivalent with other relevant details (e.g. video card driver version for display bugs, etc) -->
-        <!-- Zed Version: 0.xxx.x; Channel: Stable, OS: macOS xx.xx, RAM: XXGB, Architecture: x86_64"
+        Output of "zed: Copy System Specs Into Clipboard"
    validations:
      required: true
-  - type: textarea
-    attributes:
-      label: If applicable, add screenshots or screencasts of the incorrect state / behavior
-      description: Drag images / videos into the text input below
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: If applicable, attach your 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
--- a/.github/ISSUE_TEMPLATE/2_crash_report.yml
+++ b/.github/ISSUE_TEMPLATE/2_crash_report.yml
@ -1,26 +1,35 @@
 name: Crash Report
-description: |
-  Use this template for crash reports.
-labels: ["admin read", "triage", "bug", "panic / crash"]
+description: Zed is Crashing or Hanging
+type: "Crash"
 body:
-  - type: checkboxes
-    attributes:
-      label: Check for existing issues
-      description: Check the backlog of issues to reduce the chances of creating duplicates; if an issue already exists, place a `+1` (👍) on it.
-      options:
-        - label: Completed
-          required: true
  - type: textarea
    attributes:
      label: Describe the bug / provide steps to reproduce it
-      description: A clear and concise description of what the bug is.
+      description: A one line summary, and detailed reproduction steps
+      value: |
+        Summary:
+
+        <!-- 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: Environment
-      description: Run the `copy system specs into clipboard` command palette action and paste the output in the field below. If you are unable to run the command, please include your Zed version and release channel, operating system and version, RAM amount, and architecture.
+      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
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@ -1,15 +1,9 @@
 # yaml-language-server: $schema=https://json.schemastore.org/github-issue-config.json
 blank_issues_enabled: false
 contact_links:
-  - name: Language Request
-    url: https://github.com/zed-industries/extensions/issues/new?assignees=&labels=language&projects=&template=1_language_request.yml&title=%3Cname_of_language%3E
-    about: Request a language in the extensions repository
-  - name: Theme Request
-    url: https://github.com/zed-industries/extensions/issues/new?assignees=&labels=theme&projects=&template=0_theme_request.yml&title=%3Cname_of_theme%3E+theme
-    about: Request a theme in the extensions repository
-  - name: Platform Support
-    url: https://github.com/zed-industries/zed/issues/5391
-    about: A quick note on platform support
-  - name: Positive Feedback
-    url: https://github.com/zed-industries/zed/discussions/5397
-    about: A central location for kind words about Zed
+  - name: Zed Discussion Forum
+    url: https://github.com/zed-industries/zed/discussions
+    about: A community discussion forum
+  - name: "Zed Discord: #Support Channel"
+    url: https://zed.dev/community-links
+    about: Real-time discussion and user support