Skip to content

Commit 059f5d6

Browse files
authored
Refresh Remote - SSH Bug template (#10573)
* refresh Remote - SSH Bug template * Fix label formatting in SSH bug form * Update Remote-SSH bug form template * Update SSH log inclusion instructions in template * formatting
1 parent b6ba405 commit 059f5d6

File tree

1 file changed

+40
-23
lines changed

1 file changed

+40
-23
lines changed
Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,68 @@
11
name: Remote-SSH Bug
22
description: File a bug/issue for the Remote-SSH extension
3-
title: "[Remote-SSH Bug]: "
3+
title: "[Remote-SSH Bug]: <MY_TITLE>"
44
labels: ["ssh"]
55
assignees:
6-
- "joshspicer"
7-
- "roblourens"
6+
- "joshspicer"
7+
- "roblourens"
88
body:
99
- type: markdown
1010
attributes:
1111
value: |
12-
Thanks for filling out a bug report and helping improve the Remote-SSH extension!
12+
Thanks for filling out a bug report and helping improve the Remote - SSH extension! **Please replace <MY_TITLE> above.**
1313
If you have a feature request for Remote-SSH please use the general `Feature request` issue creation button on the previous page.
1414
- type: checkboxes
1515
attributes:
1616
label: Is there an existing issue for this bug?
17-
description: Please search [here](https://github.com/microsoft/vscode-remote-release/issues?q=is%3Aopen+is%3Aissue+label%3Assh) to see if an open or closed issue already exists for the bug you have encountered.
17+
description: Please search [here](https://github.com/microsoft/vscode-remote-release/issues?q=is%3Aopen+is%3Aissue+label%3Assh) to see if an open or closed issue already exists for the bug you have found.
1818
options:
19-
- label: I have searched the existing issues
20-
required: true
19+
- label: I have searched the existing open issues and found none that apply.
20+
required: true
21+
- label: If I find any issue of interest that is related or closed, I will included a link to it in this issue.
22+
required: true
2123
- type: checkboxes
2224
attributes:
2325
label: Required Troubleshooting Steps
24-
description: Please go through this troubleshooting help document and follow all the required steps, https://code.visualstudio.com/docs/remote/troubleshooting.
26+
description: Please go through the [**Troubleshooting Wiki**](https://github.com/microsoft/vscode-remote-release/wiki/Remote-SSH-troubleshooting) and follow all the required steps.
2527
options:
26-
- label: I have followed these troubleshooting steps
27-
required: true
28-
- label: I have tried both values of the `remote.SSH.useLocalServer` setting [(more info here)](https://github.com/microsoft/vscode-remote-release/wiki/Remote-SSH-troubleshooting#troubleshooting-steps)
28+
- label: I have followed these troubleshooting steps
29+
required: true
30+
- label: I have tried both values of the `remote.SSH.useLocalServer` setting
31+
required: true
32+
- label: My issue was not covered in the [**Tips and Tricks**](https://code.visualstudio.com/docs/remote/troubleshooting#_ssh-tips) linked from the [troubleshooting wiki](https://github.com/microsoft/vscode-remote-release/wiki/Remote-SSH-troubleshooting).
33+
required: true
34+
- label: "I will include a complete copy of my Remote - SSH logs by running `Remote-SSH: Show Log` in the command palette or opening the `Output` panel"
35+
required: true
2936
- type: dropdown
37+
id: copilot-chat
3038
attributes:
31-
label: Connect Locally
32-
description: When you tried running the ssh connection command in your local terminal what was the outcome? (please verify this connection command is exactly the same as the one in the logs labeled “Running SSH connection command”. Steps provided in troubleshoot doc.)
39+
label: "[Optional] Diagnose with Copilot"
40+
description: Recent versions of Remote - SSH include a [Copilot Chat Participant](https://code.visualstudio.com/docs/copilot/getting-started-chat) named `@remote-ssh`. When prompted, this participant can help diagnose issues.
3341
options:
34-
- It connects successfully
35-
- It doesn’t connect successfully (same error message)
36-
- It doesn’t connect successfully (different error message)
42+
- I did not ask the `@remote-ssh` participant for help
43+
- I asked `@remote-ssh` but it did not help
44+
- I asked `@remote-ssh` and it helped, but I still want to report this bug
45+
- type: dropdown
46+
id: manually-run-ssh-cmd
47+
attributes:
48+
label: In step 2 of the troubleshooting wiki, what was the result of running the generated SSH command verbatim _outside_ of VS Code?
49+
options:
50+
- I did not try step 2 of the troubleshooting steps
51+
- I could successfully SSH to the remote machine with the generated SSH command
52+
- I could *not* successfully SSH to the remote machine, and the error was _the same_ to what I saw in VS Code
53+
- I could *not* successfully SSH to the remote machine, and the error was _different_ than what I saw in VS Code
3754
validations:
3855
required: true
3956
- type: textarea
4057
attributes:
41-
label: ->
42-
description: If your connection had a different error message when trying one of the above steps or if there was an impact by toggling the `remote.SSH.useLocalServer` setting please elaborate here.
58+
label: Expected Behavior
59+
description: A concise description of what you expected to happen.
4360
validations:
4461
required: false
4562
- type: textarea
4663
attributes:
47-
label: Expected Behavior
48-
description: A concise description of what you expected to happen.
64+
label: Actual Behavior
65+
description: A concise description of what is actually happening
4966
validations:
5067
required: false
5168
- type: textarea
@@ -62,14 +79,14 @@ body:
6279
- type: textarea
6380
attributes:
6481
label: Remote-SSH Log
65-
description: To find logs first click on the `View` menu at the very top of your computer screen, and then select `Output` from the dropdown. Finally, select `Remote-SSH` from the dropdown on the top right of the `Output` window. Please make sure to provide the entire log as all output is helpful to our debugging.
82+
description: To find logs first click on the `View` menu at the very top of your computer screen, and then select `Output` from the dropdown. Finally, select `Remote-SSH` from the dropdown on the right.
6683
value: |
6784
<details>
6885
<summary>Remote-SSH Log</summary>
6986
<p>
7087
7188
```
72-
[PASTE LOG HERE]
89+
[PASTE LOG HERE WITHIN THE BACKTICKS TO FORMAT]
7390
```
7491
7592
</p>
@@ -81,7 +98,7 @@ body:
8198
label: Anything else?
8299
description: |
83100
Links? References? Anything that will give us more context about the issue you are encountering!
84-
101+
85102
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
86103
validations:
87104
required: false

0 commit comments

Comments
 (0)