Skip to content

Commit 5d2bde7

Browse files
committed
Add issue reporting documentation and template
This change adds documentation in the README.md which explains how users should file issues they find with the extension and also how they should gather and include logs. It also adds a new issue template which reminds them to follow the suggested steps and provide additional information.
1 parent 40d8da1 commit 5d2bde7

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

ISSUE_TEMPLATE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
**Please fill in these details so that we can help you!**
2+
3+
### System Details
4+
5+
- Operating system name and version:
6+
- VS Code version:
7+
- PowerShell extension version:
8+
- Output from `$PSVersionTable`:
9+
10+
```
11+
Evaluate $PSVersionTable in PowerShell and paste the output here
12+
```
13+
14+
### Issue Description
15+
16+
I am experiencing a problem with...
17+
18+
### Attached Logs
19+
20+
Follow the instructions in the [README](https://github.com/PowerShell/vscode-powershell#reporting-problems)
21+
about capturing and sending logs.

README.md

+35
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,41 @@ To open/view the extension's examples Visual Studio Code, run the following from
4242
code (Get-ChildItem $Home\.vscode\extensions\ms-vscode.PowerShell-*\examples)[-1]
4343
```
4444

45+
## Reporting Problems
46+
47+
If you're having trouble with the PowerShell extension, please follow these instructions
48+
to file an issue on our GitHub repository:
49+
50+
### 1. File an issue on our [Issues Page](https://github.com/PowerShell/vscode-powershell/issues)
51+
52+
Make sure to fill in the information that is requested in the issue template as it
53+
will help us investigate the problem more quickly.
54+
55+
### 2. Capture verbose logs and send them to us
56+
57+
If you're having an issue with crashing or other erratic behavior, add the following
58+
line to your User Settings in Visual Studio Code:
59+
60+
```json
61+
"powershell.developer.editorServicesLogLevel": "Verbose"
62+
```
63+
64+
Restart Visual Studio Code and try to reproduce the problem. Once you are done with
65+
that, zip up the logs in the corresponding folder for your operating system:
66+
67+
- **Windows**: `$HOME\.vscode\extensions\ms-vscode.PowerShell-<CURRENT VERSION>\logs`
68+
- **Linux and Mac OS X**: `~/.vscode/extensions/ms-vscode.PowerShell-<CURRENT VERSION>/logs`
69+
70+
You have two options for sending us the logs:
71+
72+
1. If you are editing scripts that contain sensitive information (intellectual property,
73+
deployment or administrative information, etc), e-mail the logs directly to
74+
*daviwil [at] microsoft.com*
75+
76+
2. If you are editing scripts that don't contain sensitive information, you can drag and
77+
drop your logs ZIP file into the GitHub issue that you are creating.
78+
79+
4580
## Contributing to the Code
4681

4782
Check out the [development documentation](docs/development.md) for more details

0 commit comments

Comments
 (0)