Refine GitHub Issue templates (#28345)
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
This commit is contained in:
parent
feafad2f9d
commit
9fb77ad176
36
.github/ISSUE_TEMPLATE/01_bug_agent.yml
vendored
Normal file
36
.github/ISSUE_TEMPLATE/01_bug_agent.yml
vendored
Normal file
@ -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
|
51
.github/ISSUE_TEMPLATE/01_git_bug_report.yml
vendored
51
.github/ISSUE_TEMPLATE/01_git_bug_report.yml
vendored
@ -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
|
|
51
.github/ISSUE_TEMPLATE/02_agent_bug_report.yml
vendored
51
.github/ISSUE_TEMPLATE/02_agent_bug_report.yml
vendored
@ -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
|
|
@ -1,5 +1,5 @@
|
|||||||
name: Edit Predictions Bug Report
|
name: Bug Report (Edit Predictions)
|
||||||
description: There is a bug related to Edit Predictions in Zed
|
description: Zed Edit Predictions bugs
|
||||||
type: "Bug"
|
type: "Bug"
|
||||||
labels: ["ai", "inline completion", "zeta"]
|
labels: ["ai", "inline completion", "zeta"]
|
||||||
title: "Edit Predictions: <a short description of the Edit Prediction bug>"
|
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
|
description: Describe the bug with a one line summary, and provide detailed reproduction steps
|
||||||
value: |
|
value: |
|
||||||
<!-- Please insert a one line summary of the issue below -->
|
<!-- 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:
|
Steps to trigger the problem:
|
||||||
1.
|
1.
|
||||||
2.
|
2.
|
||||||
3.
|
3.
|
||||||
|
|
||||||
Actual Behavior:
|
Actual Behavior:
|
||||||
|
|
||||||
Expected Behavior:
|
Expected Behavior:
|
||||||
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: environment
|
id: environment
|
||||||
attributes:
|
attributes:
|
||||||
@ -32,20 +34,3 @@ body:
|
|||||||
Output of "zed: Copy System Specs Into Clipboard"
|
Output of "zed: Copy System Specs Into Clipboard"
|
||||||
validations:
|
validations:
|
||||||
required: true
|
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
|
|
35
.github/ISSUE_TEMPLATE/03_bug_git.yml
vendored
Normal file
35
.github/ISSUE_TEMPLATE/03_bug_git.yml
vendored
Normal file
@ -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
|
43
.github/ISSUE_TEMPLATE/10_bug_report.yml
vendored
43
.github/ISSUE_TEMPLATE/10_bug_report.yml
vendored
@ -1,45 +1,43 @@
|
|||||||
name: Bug Report
|
name: Bug Report (Other)
|
||||||
description: |
|
description: |
|
||||||
Something is broken in Zed (exclude crashing).
|
Something else is broken in Zed (exclude crashing).
|
||||||
type: "Bug"
|
type: "Bug"
|
||||||
body:
|
body:
|
||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Summary
|
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: |
|
value: |
|
||||||
<!-- Please insert a one line summary of the issue below -->
|
<!-- Begin your issue with a one sentence summary -->
|
||||||
|
|
||||||
SUMMARY_SENTENCE_HERE
|
SUMMARY_SENTENCE_HERE
|
||||||
|
|
||||||
<!-- Be verbose: Include all steps necessary to reproduce from a clean Zed installation. -->
|
### Description
|
||||||
<!-- Code snippets are better than images, a repository link that reproduces the issue is ideal. -->
|
<!-- 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.
|
1.
|
||||||
2.
|
2.
|
||||||
3.
|
3.
|
||||||
4.
|
4.
|
||||||
|
|
||||||
|
Expected Behavior:
|
||||||
Actual Behavior:
|
Actual Behavior:
|
||||||
|
|
||||||
Expected Behavior:
|
<!-- 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>click to expand</summary>
|
||||||
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?
|
```json
|
||||||
- When including large items (videos, screenshots, logs, configs) please wrap with:
|
|
||||||
|
|
||||||
<details><summary>See inside for XXXXYYY</summary>
|
|
||||||
|
|
||||||
```shell
|
|
||||||
code
|
|
||||||
```
|
```
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
-->
|
-->
|
||||||
|
|
||||||
@ -50,7 +48,8 @@ body:
|
|||||||
id: environment
|
id: environment
|
||||||
attributes:
|
attributes:
|
||||||
label: Zed Version and System Specs
|
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: |
|
placeholder: |
|
||||||
Output of "zed: Copy System Specs Into Clipboard"
|
Output of "zed: Copy System Specs Into Clipboard"
|
||||||
validations:
|
validations:
|
||||||
|
14
.github/ISSUE_TEMPLATE/11_crash_report.yml
vendored
14
.github/ISSUE_TEMPLATE/11_crash_report.yml
vendored
@ -5,10 +5,12 @@ body:
|
|||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Summary
|
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: |
|
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 -->
|
<!-- Include all steps necessary to reproduce from a clean Zed installation. Be verbose -->
|
||||||
Steps to trigger the problem:
|
Steps to trigger the problem:
|
||||||
1.
|
1.
|
||||||
@ -16,7 +18,6 @@ body:
|
|||||||
3.
|
3.
|
||||||
|
|
||||||
Actual Behavior:
|
Actual Behavior:
|
||||||
|
|
||||||
Expected Behavior:
|
Expected Behavior:
|
||||||
|
|
||||||
validations:
|
validations:
|
||||||
@ -40,10 +41,11 @@ body:
|
|||||||
value: |
|
value: |
|
||||||
<details><summary>Zed.log</summary>
|
<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:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
|
5
.github/ISSUE_TEMPLATE/config.yml
vendored
5
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -4,9 +4,6 @@ contact_links:
|
|||||||
- name: Feature Request
|
- name: Feature Request
|
||||||
url: https://github.com/zed-industries/zed/discussions/new/choose
|
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
|
about: To request a feature, open a new Discussion in one of the appropriate Discussion categories
|
||||||
- name: Zed Discussion Forum
|
- name: "Zed Discord"
|
||||||
url: https://github.com/zed-industries/zed/discussions
|
|
||||||
about: A community discussion forum
|
|
||||||
- name: "Zed Discord: #Support Channel"
|
|
||||||
url: https://zed.dev/community-links
|
url: https://zed.dev/community-links
|
||||||
about: Real-time discussion and user support
|
about: Real-time discussion and user support
|
||||||
|
Loading…
Reference in New Issue
Block a user