From 82b81ed6d6ef429df28e4372af6c4771339edf06 Mon Sep 17 00:00:00 2001 From: Peter Tripp Date: Mon, 27 Jan 2025 17:38:29 -0500 Subject: [PATCH] New GitHub Issue Templates (#23745) Co-authored-by: Joseph T. Lyons Co-authored-by: Conrad Irwin --- .github/ISSUE_TEMPLATE/0_feature_request.yml | 34 +++-------- .github/ISSUE_TEMPLATE/1_bug_report.yml | 60 +++++++------------- .github/ISSUE_TEMPLATE/2_crash_report.yml | 35 +++++++----- .github/ISSUE_TEMPLATE/config.yml | 18 ++---- 4 files changed, 56 insertions(+), 91 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/0_feature_request.yml b/.github/ISSUE_TEMPLATE/0_feature_request.yml index 900df46e7a..730909153a 100644 --- 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: | - - - 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: + diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yml b/.github/ISSUE_TEMPLATE/1_bug_report.yml index 3a26baa739..3e014ecf83 100644 --- 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: + + + 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: | - - - - - ``` - - ``` - - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/2_crash_report.yml b/.github/ISSUE_TEMPLATE/2_crash_report.yml index 87f2766791..a19672c24f 100644 --- 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: + + + 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 2c150a10bd..9a51874331 100644 --- 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