Skip to content

Commit 0e384d5

Browse files
committed
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.
1 parent 760d131 commit 0e384d5

File tree

3 files changed

+35
-19
lines changed

3 files changed

+35
-19
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
name: Bug report
22
description: File a bug report
3-
title: "[Bug]: "
43
labels: ["bug", "triage"]
54
body:
65
- type: checkboxes
@@ -10,6 +9,7 @@ body:
109
options:
1110
- label: I have searched the existing issues
1211
required: true
12+
1313
- type: textarea
1414
attributes:
1515
label: OS/Web Information
@@ -28,62 +28,82 @@ body:
2828
- `code-server --version`:
2929
validations:
3030
required: true
31+
3132
- type: textarea
3233
attributes:
3334
label: Steps to Reproduce
3435
description: |
35-
1. open code-server
36-
2. install extension
37-
3. run command
36+
Please describe exactly how to reproduce the bug. For example:
37+
1. Open code-server in Firefox
38+
2. Install extension `foo.bar` from the extensions sidebar
39+
3. Run command `foo.bar.baz`
3840
value: |
3941
1.
4042
2.
4143
3.
4244
validations:
4345
required: true
46+
4447
- type: textarea
4548
attributes:
4649
label: Expected
4750
description: What should happen?
4851
validations:
4952
required: true
53+
5054
- type: textarea
5155
attributes:
5256
label: Actual
5357
description: What actually happens?
5458
validations:
5559
required: true
60+
5661
- type: textarea
5762
id: logs
5863
attributes:
5964
label: Logs
6065
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`).
66+
render: shell
67+
6168
- type: textarea
6269
attributes:
6370
label: Screenshot/Video
6471
description: Please include a screenshot, gif or screen recording of your issue.
6572
validations:
6673
required: false
67-
- type: checkboxes
74+
75+
- type: dropdown
6876
attributes:
69-
label: Does this issue happen in VS Code or GitHub Codespaces?
70-
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).
77+
label: Does this bug reproduce in native VS Code?
78+
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).
7179
options:
72-
- label: I tested this in native VS Code.
73-
required: false
74-
- label: This does not happen in native VS Code.
75-
required: false
76-
- label: I tested this in GitHub Codespaces.
77-
required: false
78-
- label: This does not happen in GitHub Codespaces.
79-
required: false
80+
- Yes, this is also broken in native VS Code
81+
- No, this works as expected in native VS Code
82+
- This cannot be tested in native VS Code
83+
- I did not test native VS Code
84+
validations:
85+
required: true
86+
87+
- type: dropdown
88+
attributes:
89+
label: Does this bug reproduce in GitHub Codespaces?
90+
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).
91+
options:
92+
- Yes, this is also broken in GitHub Codespaces
93+
- No, this works as expected in GitHub Codespaces
94+
- This cannot be tested in GitHub Codespaces
95+
- I did not test GitHub Codespaces
96+
validations:
97+
required: true
98+
8099
- type: checkboxes
81100
attributes:
82101
label: Are you accessing code-server over a secure context?
83102
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.
84103
options:
85104
- label: I am using a secure context.
86105
required: false
106+
87107
- type: textarea
88108
attributes:
89109
label: Notes

.github/ISSUE_TEMPLATE/doc.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
---
22
name: Documentation improvement
33
about: Suggest a documentation improvement
4-
title: "[Docs]: "
54
labels: "docs"
6-
assignees: "@jsjoeio"
75
---
86

97
## What is your suggestion?

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
---
22
name: Feature request
33
about: Suggest an idea to improve code-server
4-
title: "[Feat]: "
54
labels: enhancement
6-
assignees: ""
75
---
86

97
## What is your suggestion?

0 commit comments

Comments
 (0)