Skip to content

Commit

Permalink
Tweak issue templates
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
code-asher committed Mar 14, 2024
1 parent 760d131 commit 0e384d5
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 19 deletions.
50 changes: 35 additions & 15 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
name: Bug report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: checkboxes
Expand All @@ -10,6 +9,7 @@ body:
options:
- label: I have searched the existing issues
required: true

- type: textarea
attributes:
label: OS/Web Information
Expand All @@ -28,62 +28,82 @@ body:
- `code-server --version`:
validations:
required: true

- type: textarea
attributes:
label: Steps to Reproduce
description: |
1. open code-server
2. install extension
3. run command
Please describe exactly how to reproduce the bug. For example:
1. Open code-server in Firefox
2. Install extension `foo.bar` from the extensions sidebar
3. Run command `foo.bar.baz`
value: |
1.
2.
3.
validations:
required: true

- type: textarea
attributes:
label: Expected
description: What should happen?
validations:
required: true

- type: textarea
attributes:
label: Actual
description: What actually happens?
validations:
required: true

- type: textarea
id: logs
attributes:
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`).
render: shell

- type: textarea
attributes:
label: Screenshot/Video
description: Please include a screenshot, gif or screen recording of your issue.
validations:
required: false
- type: checkboxes

- type: dropdown
attributes:
label: Does this issue happen in VS Code or GitHub Codespaces?
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).
label: Does this bug reproduce in native VS Code?
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:
- label: I tested this in native VS Code.
required: false
- label: This does not happen in native VS Code.
required: false
- label: I tested this in GitHub Codespaces.
required: false
- label: This does not happen in GitHub Codespaces.
required: false
- Yes, this is also broken in native VS Code
- No, this works as expected in native VS Code
- This cannot be tested in native VS Code
- I did not test native VS Code
validations:
required: true

- 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
attributes:
label: Are you accessing code-server over a secure context?
description: code-server relies on service workers (which only work in secure contexts) for many features. Double-check that you are using a secure context like HTTPS or localhost.
options:
- label: I am using a secure context.
required: false

- type: textarea
attributes:
label: Notes
Expand Down
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE/doc.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
name: Documentation improvement
about: Suggest a documentation improvement
title: "[Docs]: "
labels: "docs"
assignees: "@jsjoeio"
---

## What is your suggestion?
Expand Down
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
name: Feature request
about: Suggest an idea to improve code-server
title: "[Feat]: "
labels: enhancement
assignees: ""
---

## What is your suggestion?
Expand Down

0 comments on commit 0e384d5

Please sign in to comment.