Skip to content

Commit f494793

Browse files
authored
More touch ups in issue template (#10574)
* more touch ups in issue template * move logs up
1 parent 059f5d6 commit f494793

File tree

1 file changed

+34
-31
lines changed

1 file changed

+34
-31
lines changed

.github/ISSUE_TEMPLATE/a_remote_ssh_bug_form.yml

+34-31
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ body:
99
- type: markdown
1010
attributes:
1111
value: |
12-
Thanks for filling out a bug report and helping improve the Remote - SSH extension! **Please replace <MY_TITLE> above.**
12+
Thank you for taking the time to fill out a bug report, we appreciate your help in improving Remote - SSH!
13+
14+
Please take the time to fill out this brief form to ensure we can triage your issue promptly. Please be sure to **replace <MY_TITLE> above with something descriptive!**
15+
1316
If you have a feature request for Remote-SSH please use the general `Feature request` issue creation button on the previous page.
1417
- type: checkboxes
1518
attributes:
@@ -25,46 +28,63 @@ body:
2528
label: Required Troubleshooting Steps
2629
description: Please go through the [**Troubleshooting Wiki**](https://github.com/microsoft/vscode-remote-release/wiki/Remote-SSH-troubleshooting) and follow all the required steps.
2730
options:
28-
- label: I have followed these troubleshooting steps
31+
- label: I have read and performed the troubleshooting steps
2932
required: true
3033
- label: I have tried both values of the `remote.SSH.useLocalServer` setting
3134
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).
35+
- 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).
3336
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"
37+
- label: "I will include a complete copy of my Remote - SSH logs by running **Remote-SSH: Show Log** in the command palette or from **View > Output** in the menu bar"
3538
required: true
3639
- type: dropdown
3740
id: copilot-chat
3841
attributes:
3942
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.
43+
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 or answer general SSH configuration questions.
4144
options:
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+
- I did not ask the @remote-ssh participant for help
46+
- I asked @remote-ssh but it did not help
47+
- I asked @remote-ssh and it helped, but I still want to report this bug
48+
validations:
49+
required: true
4550
- type: dropdown
4651
id: manually-run-ssh-cmd
4752
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?
53+
label: In step 2 of the troubleshooting wiki, what was the result of running the generated SSH command verbatim outside of VS Code?
4954
options:
5055
- 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
56+
- I COULD successfully SSH to the remote machine with the generated SSH command
57+
- I could NOT successfully SSH to the remote machine, and the error was the SAME to what I saw in VS Code
58+
- I could NOT successfully SSH to the remote machine, and the error was DIFFERENT than what I saw in VS Code
59+
validations:
60+
required: true
61+
- type: textarea
62+
attributes:
63+
label: Remote-SSH Log
64+
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.
65+
value: |
66+
<details>
67+
<summary>Remote-SSH Log</summary>
68+
<p>
69+
```
70+
[PASTE LOG HERE WITHIN THE BACKTICKS TO FORMAT]
71+
```
72+
</p>
73+
</details>
5474
validations:
5575
required: true
5676
- type: textarea
5777
attributes:
5878
label: Expected Behavior
5979
description: A concise description of what you expected to happen.
6080
validations:
61-
required: false
81+
required: true
6282
- type: textarea
6383
attributes:
6484
label: Actual Behavior
6585
description: A concise description of what is actually happening
6686
validations:
67-
required: false
87+
required: true
6888
- type: textarea
6989
attributes:
7090
label: Steps To Reproduce
@@ -74,23 +94,6 @@ body:
7494
2. With this config...
7595
3. Run '...'
7696
4. See error...
77-
validations:
78-
required: false
79-
- type: textarea
80-
attributes:
81-
label: Remote-SSH Log
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.
83-
value: |
84-
<details>
85-
<summary>Remote-SSH Log</summary>
86-
<p>
87-
88-
```
89-
[PASTE LOG HERE WITHIN THE BACKTICKS TO FORMAT]
90-
```
91-
92-
</p>
93-
</details>
9497
validations:
9598
required: true
9699
- type: textarea

0 commit comments

Comments
 (0)