From 5ede48337c8266ce8f16149b0b04e3c0614be3d8 Mon Sep 17 00:00:00 2001 From: Peter Tripp Date: Tue, 18 Jun 2024 12:15:05 -0400 Subject: [PATCH] GitHub Issue Templates: Hide Zed Logs (#13211) Add details/summary block to GitHub issue templates so zed.log can be hidden by default. The diff for this is messy because the existing files were not correctly auto-formatted. So I created two commits, one for autoformat and the other for the changes. I tested it on a private repo. When you first open the issue it looks like this: image Then when you double-click inside it becomes editable: image Release Notes: - N/A --- .github/ISSUE_TEMPLATE/0_feature_request.yml | 38 +++++----- .github/ISSUE_TEMPLATE/1_bug_report.yml | 75 +++++++++++--------- .github/ISSUE_TEMPLATE/2_crash_report.yml | 61 ++++++++-------- 3 files changed, 92 insertions(+), 82 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/0_feature_request.yml b/.github/ISSUE_TEMPLATE/0_feature_request.yml index c5e1fa9237..d8dc7950f6 100644 --- a/.github/ISSUE_TEMPLATE/0_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/0_feature_request.yml @@ -2,23 +2,23 @@ name: Feature Request description: "Tip: open this issue template from within Zed with the `request feature` command palette action" labels: ["admin read", "triage", "enhancement"] 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: + - 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: | - If applicable, add mockups / screenshots to help present your vision of the feature - description: Drag images into the text input below - validations: - required: false + - type: textarea + attributes: + label: Describe the feature + description: A clear and concise description of what you want to happen. + 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 diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yml b/.github/ISSUE_TEMPLATE/1_bug_report.yml index ccdd084533..db88ddd3d6 100644 --- a/.github/ISSUE_TEMPLATE/1_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/1_bug_report.yml @@ -1,40 +1,45 @@ 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. + 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", "defect"] 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. - validations: + - 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 - id: environment - attributes: - label: Environment - description: Run the `copy system specs into clipboard` command palette action and paste the output in the field below. - validations: - required: true - - type: textarea - attributes: - label: If applicable, add mockups / screenshots to help explain present your vision of the feature - description: Drag issues into the text input below - validations: - required: false - - type: textarea - attributes: - label: If applicable, attach your `~/Library/Logs/Zed/Zed.log` file to this issue. - description: | - Drag Zed.log into the text input below. - If you only need the most recent lines, you can run the `zed: open log` command palette action to see the last 1000. - validations: - required: false + - type: textarea + attributes: + label: Describe the bug / provide steps to reproduce it + description: A clear and concise description of what the bug is. + 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. + validations: + required: true + - type: textarea + attributes: + label: If applicable, add mockups / screenshots to help explain present your vision of the feature + description: Drag issues into the text input below + validations: + required: false + - type: textarea + attributes: + label: If applicable, attach your `~/Library/Logs/Zed/Zed.log` file to this issue. + description: | + Drag Zed.log into the text input below. + If you only need the most recent lines, you can run the `zed: open log` command palette action to see the last 1000. + value: | +
Zed.log
+        
+
+        
+ validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/2_crash_report.yml b/.github/ISSUE_TEMPLATE/2_crash_report.yml index c877ff1f4d..ff60329e43 100644 --- a/.github/ISSUE_TEMPLATE/2_crash_report.yml +++ b/.github/ISSUE_TEMPLATE/2_crash_report.yml @@ -1,33 +1,38 @@ name: Crash Report description: | - Use this template for crash reports. + Use this template for crash reports. labels: ["admin read", "triage", "defect", "panic / 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. - validations: + - 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 - id: environment - attributes: - label: Environment - description: Run the `copy system specs into clipboard` command palette action and paste the output in the field below. - validations: - required: true - - type: textarea - attributes: - label: If applicable, attach your `~/Library/Logs/Zed/Zed.log` file to this issue. - description: | - Drag Zed.log into the text input below. - If you only need the most recent lines, you can run the `zed: open log` command palette action to see the last 1000. - validations: - required: false + - type: textarea + attributes: + label: Describe the bug / provide steps to reproduce it + description: A clear and concise description of what the bug is. + 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. + validations: + required: true + - type: textarea + attributes: + label: If applicable, attach your `~/Library/Logs/Zed/Zed.log` file to this issue. + description: | + Drag Zed.log into the text input below. + If you only need the most recent lines, you can run the `zed: open log` command palette action to see the last 1000. + value: | +
Zed.log
+        
+
+        
+ validations: + required: false