Archived
1
0

Tweak issue templates

- Remove the redundant title prefix.
- Remove outdated assignees.
- Improve reproduction step description (trying to get folks to submit
  more specific/detailed reproductions).
- Render logs with shell (not sure if this actually changes anything).
- Use dropdowns for testing in VS Code and Codespaces.  I think the
  existing checkboxes are still confusing so hopefully this sorts it.
This commit is contained in:
Asher 2024-03-14 11:46:40 -08:00
parent 760d1318e9
commit 0e384d5442
No known key found for this signature in database
GPG Key ID: D63C1EF81242354A
3 changed files with 35 additions and 19 deletions

View File

@ -1,6 +1,5 @@
name: Bug report name: Bug report
description: File a bug report description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"] labels: ["bug", "triage"]
body: body:
- type: checkboxes - type: checkboxes
@ -10,6 +9,7 @@ body:
options: options:
- label: I have searched the existing issues - label: I have searched the existing issues
required: true required: true
- type: textarea - type: textarea
attributes: attributes:
label: OS/Web Information label: OS/Web Information
@ -28,55 +28,74 @@ body:
- `code-server --version`: - `code-server --version`:
validations: validations:
required: true required: true
- type: textarea - type: textarea
attributes: attributes:
label: Steps to Reproduce label: Steps to Reproduce
description: | description: |
1. open code-server Please describe exactly how to reproduce the bug. For example:
2. install extension 1. Open code-server in Firefox
3. run command 2. Install extension `foo.bar` from the extensions sidebar
3. Run command `foo.bar.baz`
value: | value: |
1. 1.
2. 2.
3. 3.
validations: validations:
required: true required: true
- type: textarea - type: textarea
attributes: attributes:
label: Expected label: Expected
description: What should happen? description: What should happen?
validations: validations:
required: true required: true
- type: textarea - type: textarea
attributes: attributes:
label: Actual label: Actual
description: What actually happens? description: What actually happens?
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: logs id: logs
attributes: attributes:
label: Logs label: Logs
description: Run code-server with the --verbose flag and then paste any relevant logs from the server, from the browser console and/or the browser network tab. For issues with installation, include installation logs (i.e. output of `yarn global add code-server`). description: Run code-server with the --verbose flag and then paste any relevant logs from the server, from the browser console and/or the browser network tab. For issues with installation, include installation logs (i.e. output of `yarn global add code-server`).
render: shell
- type: textarea - type: textarea
attributes: attributes:
label: Screenshot/Video label: Screenshot/Video
description: Please include a screenshot, gif or screen recording of your issue. description: Please include a screenshot, gif or screen recording of your issue.
validations: validations:
required: false required: false
- type: checkboxes
- type: dropdown
attributes: attributes:
label: Does this issue happen in VS Code or GitHub Codespaces? label: Does this bug reproduce in native VS Code?
description: Please try reproducing this issue in VS Code and GitHub Codespaces. If the bug reproduces in either VS Code or GitHub Codespaces, please submit the issue upstream instead (https://github.com/microsoft/vscode). description: Please try reproducing this issue in native VS Code, if possible. If the bug reproduces in native VS Code, please submit the issue upstream instead (https://github.com/microsoft/vscode).
options: options:
- label: I tested this in native VS Code. - Yes, this is also broken in native VS Code
required: false - No, this works as expected in native VS Code
- label: This does not happen in native VS Code. - This cannot be tested in native VS Code
required: false - I did not test native VS Code
- label: I tested this in GitHub Codespaces. validations:
required: false required: true
- label: This does not happen in GitHub Codespaces.
required: false - type: dropdown
attributes:
label: Does this bug reproduce in GitHub Codespaces?
description: Please try reproducing this issue in GitHub Codespaces, if possible. If the bug reproduces in GitHub Codespaces, please submit the issue upstream instead (https://github.com/microsoft/vscode).
options:
- Yes, this is also broken in GitHub Codespaces
- No, this works as expected in GitHub Codespaces
- This cannot be tested in GitHub Codespaces
- I did not test GitHub Codespaces
validations:
required: true
- type: checkboxes - type: checkboxes
attributes: attributes:
label: Are you accessing code-server over a secure context? label: Are you accessing code-server over a secure context?
@ -84,6 +103,7 @@ body:
options: options:
- label: I am using a secure context. - label: I am using a secure context.
required: false required: false
- type: textarea - type: textarea
attributes: attributes:
label: Notes label: Notes

View File

@ -1,9 +1,7 @@
--- ---
name: Documentation improvement name: Documentation improvement
about: Suggest a documentation improvement about: Suggest a documentation improvement
title: "[Docs]: "
labels: "docs" labels: "docs"
assignees: "@jsjoeio"
--- ---
## What is your suggestion? ## What is your suggestion?

View File

@ -1,9 +1,7 @@
--- ---
name: Feature request name: Feature request
about: Suggest an idea to improve code-server about: Suggest an idea to improve code-server
title: "[Feat]: "
labels: enhancement labels: enhancement
assignees: ""
--- ---
## What is your suggestion? ## What is your suggestion?