Skip to content

Commit 9cbcadd

Browse files
committed
adding to extension quickstart for ts
1 parent 459d4c3 commit 9cbcadd

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

generators/app/templates/ext-command-ts/vsc-extension-quickstart.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,35 @@
3535
* The provided test runner will only consider files matching the name pattern `**.test.ts`.
3636
* You can create folders inside the `test` folder to structure your tests any way you want.
3737

38+
## Issue Reporting
39+
40+
VS Code users can report issues by using the **Help: Report Issue...** command (`workbench.action.openIssueReporter`), or by typing `issue ` in Quick Open (`workbench.action.quickOpen`) and then selecting an installed extension. This provides a consistent experience for users to report issues for the core product or installed extensions.
41+
42+
As an extension author, you can integrate your extension in the **Help: Report Issue...** issue reporter flow, instead of contributing a separate issue reporter command. This integration also enables you to attach any additional information when users report an issue.
43+
44+
To integrate in the issue reporter flow, you need to contribute a custom command and a `issue/reporter` menu contribution point. This custom command will invoke `openIssueReporter`.
45+
46+
An example of a contributed command and menu for `contributes` in `package.json` (See [Contribution Points](/api/references/contribution-points) for adding a menu contribution and command):
47+
48+
``` json
49+
"commands": [
50+
{
51+
"command": "extension.myCommand",
52+
"title": "Report Issue"
53+
}
54+
],
55+
"menus": {
56+
"issue/reporter": [
57+
{
58+
"command": "extension.myCommand"
59+
}
60+
]
61+
}
62+
63+
```
64+
65+
We ask extensions that previously contributed a `workbench.action.openIssueReporter` command in the command palette to start using this new issue reporting flow.
66+
3867
## Go further
3968

4069
* [Follow UX guidelines](https://code.visualstudio.com/api/ux-guidelines/overview) to create extensions that seamlessly integrate with VS Code's native interface and patterns.

0 commit comments

Comments
 (0)