From 092250b4fa99a0cfeb107df3f7dca8c8fd7f5d24 Mon Sep 17 00:00:00 2001 From: Kunall Banerjee <14703164+yeskunall@users.noreply.github.com> Date: Mon, 24 Nov 2025 14:12:54 -0500 Subject: [PATCH] Rework and consolidate issue templates (#43403) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit We’re reworking our triage process and in doing so, reworking our issue templates is worth looking into. We have multiple issue templates, for arbitrary categories, and not enough enforcement. The plan is to consolidate the issue templates (maybe all into one) and drop the others. Release Notes: - N/A --- .github/ISSUE_TEMPLATE/01_bug_ai.yml | 59 ----------------- .github/ISSUE_TEMPLATE/04_bug_debugger.yml | 53 --------------- .github/ISSUE_TEMPLATE/06_bug_git.yml | 53 --------------- .github/ISSUE_TEMPLATE/07_bug_windows.yml | 53 --------------- .github/ISSUE_TEMPLATE/1.bug-report.yml | 70 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/10_bug_report.yml | 75 ---------------------- .github/ISSUE_TEMPLATE/11_crash_report.yml | 50 --------------- .github/ISSUE_TEMPLATE/2.crash-report.yml | 52 +++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 10 +-- 9 files changed, 127 insertions(+), 348 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/01_bug_ai.yml delete mode 100644 .github/ISSUE_TEMPLATE/04_bug_debugger.yml delete mode 100644 .github/ISSUE_TEMPLATE/06_bug_git.yml delete mode 100644 .github/ISSUE_TEMPLATE/07_bug_windows.yml create mode 100644 .github/ISSUE_TEMPLATE/1.bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/10_bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/11_crash_report.yml create mode 100644 .github/ISSUE_TEMPLATE/2.crash-report.yml diff --git a/.github/ISSUE_TEMPLATE/01_bug_ai.yml b/.github/ISSUE_TEMPLATE/01_bug_ai.yml deleted file mode 100644 index 8d977f4f7ae603f0b2ed991ce6dabee25e045f06..0000000000000000000000000000000000000000 --- a/.github/ISSUE_TEMPLATE/01_bug_ai.yml +++ /dev/null @@ -1,59 +0,0 @@ -name: Bug Report (AI) -description: Zed Agent Panel Bugs -type: "Bug" -labels: ["area:ai"] -title: "AI: " -body: - - type: textarea - attributes: - label: Summary - description: Describe the bug with a one line summary, and provide detailed reproduction steps - value: | - - SUMMARY_SENTENCE_HERE - - ### Description - - Steps to trigger the problem: - 1. - 2. - 3. - - **Expected Behavior**: - **Actual Behavior**: - - ### Model Provider Details - - Provider: (Anthropic via ZedPro, Anthropic via API key, Copilot Chat, Mistral, OpenAI, etc) - - Model Name: - - Mode: (Agent Panel, Inline Assistant, Terminal Assistant or Text Threads) - - Other Details (MCPs, other settings, etc): - 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 `Zed.log` file to this issue. - description: | - From the command palette, run `zed: open log` to see the last 1000 lines. - Or run `zed: reveal log in file manager` to reveal the log file itself. - value: | -
Zed.log - - - ```log - - ``` - -
- validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/04_bug_debugger.yml b/.github/ISSUE_TEMPLATE/04_bug_debugger.yml deleted file mode 100644 index 3191227371a544b3ad6232c204b85afd5c6a238a..0000000000000000000000000000000000000000 --- a/.github/ISSUE_TEMPLATE/04_bug_debugger.yml +++ /dev/null @@ -1,53 +0,0 @@ -name: Bug Report (Debugger) -description: Zed Debugger-Related Bugs -type: "Bug" -labels: ["area:debugger"] -title: "Debugger:
" -body: - - type: textarea - attributes: - label: Summary - description: Describe the bug with a one line summary, and provide detailed reproduction steps - value: | - - SUMMARY_SENTENCE_HERE - - ### Description - - Steps to trigger the problem: - 1. - 2. - 3. - - **Expected Behavior**: - **Actual 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 `Zed.log` file to this issue. - description: | - From the command palette, run `zed: open log` to see the last 1000 lines. - Or run `zed: reveal log in file manager` to reveal the log file itself. - value: | -
Zed.log - - - ```log - - ``` - -
- validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/06_bug_git.yml b/.github/ISSUE_TEMPLATE/06_bug_git.yml deleted file mode 100644 index e0b6a6750879bf8de41a942e1057b9e4d5cdcc91..0000000000000000000000000000000000000000 --- a/.github/ISSUE_TEMPLATE/06_bug_git.yml +++ /dev/null @@ -1,53 +0,0 @@ -name: Bug Report (Git) -description: Zed Git Related Bugs -type: "Bug" -labels: ["area:integrations/git"] -title: "Git:
" -body: - - type: textarea - attributes: - label: Summary - description: Describe the bug with a one-line summary, and provide detailed reproduction steps - value: | - - SUMMARY_SENTENCE_HERE - - ### Description - - Steps to trigger the problem: - 1. - 2. - 3. - - **Expected Behavior**: - **Actual 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 `Zed.log` file to this issue. - description: | - From the command palette, run `zed: open log` to see the last 1000 lines. - Or run `zed: reveal log in file manager` to reveal the log file itself. - value: | -
Zed.log - - - ```log - - ``` - -
- validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/07_bug_windows.yml b/.github/ISSUE_TEMPLATE/07_bug_windows.yml deleted file mode 100644 index 7f48890eb961aa35dbae70cc22829ba6cb0e2a77..0000000000000000000000000000000000000000 --- a/.github/ISSUE_TEMPLATE/07_bug_windows.yml +++ /dev/null @@ -1,53 +0,0 @@ -name: Bug Report (Windows) -description: Zed Windows Related Bugs -type: "Bug" -labels: ["platform:windows"] -title: "Windows:
" -body: - - type: textarea - attributes: - label: Summary - description: Describe the bug with a one-line summary, and provide detailed reproduction steps - value: | - - SUMMARY_SENTENCE_HERE - - ### Description - - Steps to trigger the problem: - 1. - 2. - 3. - - **Expected Behavior**: - **Actual 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 `Zed.log` file to this issue. - description: | - From the command palette, run `zed: open log` to see the last 1000 lines. - Or run `zed: reveal log in file manager` to reveal the log file itself. - value: | -
Zed.log - - - ```log - - ``` - -
- validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/1.bug-report.yml b/.github/ISSUE_TEMPLATE/1.bug-report.yml new file mode 100644 index 0000000000000000000000000000000000000000..543c22117c2aa889b91fddd9eddd905c09dd0644 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1.bug-report.yml @@ -0,0 +1,70 @@ +name: Report an issue +description: Report an issue with Zed. +type: Bug +body: + - type: markdown + attributes: + value: | + Feature requests should be opened in [discussions](https://github.com/zed-industries/zed/discussions/new/choose). + + Before opening a new issue, please do a [search](https://github.com/zed-industries/zed/issues) of existing issues and :+1: upvote the existing issue instead. This will help us maintain a proper signal-to-noise ratio. + + If you need help with your own project, you can ask a question in our [Discord Support Forums](https://discord.com/invite/zedindustries). + - type: textarea + attributes: + label: Reproduction steps + description: A step-by-step description of how to reproduce the issue from a **clean Zed install**. Any code must be sufficient to reproduce (make sure to include context!). Include code as text, not just as a screenshot. **Issues with insufficient detail may be summarily closed**. + placeholder: | + 1. Start Zed + 2. Click X + 3. Y will happen + validations: + required: true + - type: textarea + attributes: + label: Current vs. Expected behavior + description: | + A clear and concise description of what is the current behavior (screenshots, videos), vs. what you expected the behavior to be. + + **Skipping this/failure to provide complete information will result in the issue being closed.** + placeholder: "Based on my reproduction steps above, when I click X, I expect this to happen, but instead Y happens." + validations: + required: true + - type: textarea + attributes: + label: If applicable, attach your Zed log file to this issue. + description: | + Open the command palette in Zed, then type `zed: open log` to see the last 1000 lines. Or type `zed: reveal log in file manager` in the command palette to reveal the log file itself. + value: | +
Zed.log + + + ```log + + ``` + +
+ validations: + required: false + - type: textarea + attributes: + label: If applicable, provide details about your model provider + placeholder: | + - Provider: (Anthropic via ZedPro, Anthropic via API key, Copilot Chat, Mistral, OpenAI, etc.) + - Model Name: (Claude Sonnet 4.5, Gemini 3 Pro, GPT-5) + - Mode: (Agent Panel, Inline Assistant, Terminal Assistant or Text Threads) + - Other details (ACPs, MCPs, other settings, etc.): + validations: + required: false + - type: textarea + attributes: + label: Zed version and system specs + description: | + Open the command palette in Zed, then type “zed: copy system specs into clipboard”. **Skipping this/failure to provide complete information will result in the issue being closed**. + placeholder: | + Zed: v0.215.0 (Zed Nightly bfe141ea79aa4984028934067ba75c48d99136ae) + OS: macOS 15.1 + Memory: 36 GiB + Architecture: aarch64 + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/10_bug_report.yml b/.github/ISSUE_TEMPLATE/10_bug_report.yml deleted file mode 100644 index 9f069a7a355188f91d18fc528a69433f214f5167..0000000000000000000000000000000000000000 --- a/.github/ISSUE_TEMPLATE/10_bug_report.yml +++ /dev/null @@ -1,75 +0,0 @@ -name: Bug Report (Other) -description: | - Something else is broken in Zed (exclude crashing). -type: "Bug" -body: - - type: textarea - attributes: - label: Summary - description: Provide a one sentence summary and detailed reproduction steps - value: | - - SUMMARY_SENTENCE_HERE - - ### Description - - - DESCRIPTION_HERE - - Steps to reproduce: - 1. - 2. - 3. - 4. - - **Expected Behavior**: - **Actual Behavior**: - - - - validations: - required: true - - - type: textarea - id: environment - attributes: - label: Zed Version and System Specs - description: | - Open Zed, from 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 `Zed.log` file to this issue. - description: | - From the command palette, run `zed: open log` to see the last 1000 lines. - Or run `zed: reveal log in file manager` to reveal the log file itself. - value: | -
Zed.log - - - ```log - - ``` - -
- validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/11_crash_report.yml b/.github/ISSUE_TEMPLATE/11_crash_report.yml deleted file mode 100644 index 97979308ae5ab4037c32db2660544c1299f2c750..0000000000000000000000000000000000000000 --- a/.github/ISSUE_TEMPLATE/11_crash_report.yml +++ /dev/null @@ -1,50 +0,0 @@ -name: Crash Report -description: Zed is Crashing or Hanging -type: "Crash" -body: - - type: textarea - attributes: - label: Summary - description: Summarize the issue with detailed reproduction steps - value: | - - SUMMARY_SENTENCE_HERE - - ### Description - - 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 `Zed.log` file to this issue. - description: | - From the command palette, run `zed: open log` to see the last 1000 lines. - Or run `zed: reveal log in file manager` to reveal the log file itself. - value: | -
Zed.log - - - ```log - - ``` - -
- validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/2.crash-report.yml b/.github/ISSUE_TEMPLATE/2.crash-report.yml new file mode 100644 index 0000000000000000000000000000000000000000..47cedcc3100854060c2cbde2147b754d89afef51 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2.crash-report.yml @@ -0,0 +1,52 @@ +name: Report a crash +description: Zed is crashing or freezing or hanging. +type: Crash +body: + - type: textarea + attributes: + label: Reproduction steps + description: A step-by-step description of how to reproduce the crash from a **clean Zed install**. **Be verbose**. **Issues with insufficient detail may be summarily closed**. + placeholder: | + 1. Start Zed + 2. Perform an action + 3. Zed crashes + validations: + required: true + - type: textarea + attributes: + label: Current vs. Expected behavior + description: | + Go into depth about what actions you’re performing in Zed to trigger the crash. If Zed crashes before it loads any windows, make sure to mention that. Again, **be verbose**. + + **Skipping this/failure to provide complete information will result in the issue being closed.** + placeholder: "Based on my reproduction steps above, when I perform said action, I expect this to happen, but instead Zed crashes." + validations: + required: true + - type: textarea + attributes: + label: Zed version and system specs + description: | + Open the command palette in Zed, then type “zed: copy system specs into clipboard”. **Skipping this/failure to provide complete information will result in the issue being closed**. + placeholder: | + Zed: v0.215.0 (Zed Nightly bfe141ea79aa4984028934067ba75c48d99136ae) + OS: macOS 15.1 + Memory: 36 GiB + Architecture: aarch64 + validations: + required: true + - type: textarea + attributes: + label: If applicable, attach your Zed log file to this issue + description: | + Open the command palette in Zed, then type `zed: open log` to see the last 1000 lines. Or type `zed: reveal log in file manager` in the command palette to reveal the log file itself. + value: | +
Zed.log + + + ```log + + ``` + +
+ validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 8602daf90ddd0fe49d9db27c39f3d52d6e7da032..9bf14ce72d5feb5da9f04bb1064e7351407e6f55 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,9 +1,9 @@ # yaml-language-server: $schema=https://www.schemastore.org/github-issue-config.json blank_issues_enabled: false contact_links: - - name: Feature Request + - 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 Discord" - url: https://zed.dev/community-links - about: Real-time discussion and user support + about: To request a feature, open a new discussion under one of the appropriate categories. + - name: Our Discord community + url: https://discord.com/invite/zedindustries + about: Join our Discord server for real-time discussion and user support.