-
Notifications
You must be signed in to change notification settings - Fork 29.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Proposal: Support configuring data sent to extensions for Issue Reporter #196863
Comments
ATM, known additional wants/needs: 1. Even more data:
2. Ability to edit the repository link:
export interface IssueDataProvider {
// Provide the data to be used in the issue reporter.
provideIssueData(token: CancellationToken): ProviderResult<string>;
// Provide the template to be used in the description of issue reporter.
provideIssueTemplate(token: CancellationToken): ProviderResult<string>;
// Provide the url to be filed upon.
provideIssueUrl(token: CancellationToken): ProviderResult<Uri>;
}
|
Feedback/Todo
|
Feedback/Todo:
|
closing this for now - all discussed items are now completed and shipping out this iteration
|
@caleb-at-pieces hey! yes the @jrieken I will bring this up at api sync, but I'm not sure what this would look like when finalized, is there an example of this? I see a large number of |
Great, thanks for the reply! Follow up question: Is this unrelated to https://code.visualstudio.com/updates/v1_87#_contributing-additional-data-in-issue-reporter then? It seemed by reading this that this has been finalized. There is also this: https://code.visualstudio.com/updates/v1_88#_use-issue-reporter-command-for-extension-bug-reporting on the 1.88 release notes. |
@caleb-at-pieces sorry just saw this, but no these are the same things that were finalized! the expectation is that extensions follow this command contribution structure to contribute date 👍 |
Motivation
As discussed in #46726 and #45673, now that users can choose to file on extensions, extension authors should be able to specify additional data to include in the report. This could potentially include:
Additionally, many extensions are using a similar command which creates the option in the quick pick to report on issue specifically on that extension. This flow will open the issue reporter, similarly to
Help: Report Issue
, but with the extension automatically selected, and can also provide a template to the issue body.However, with many extensions installed, this can become bloated and when extensions what users to add additional information, they would like users to go through the full flow of the reporter to ensure that users never forget to fill in information.
Proposal
Adding an API with the following:
Via
IssueUriRequestHandler
, extensions can choose to direct users to file the extension externally. By providing a URI to the API, the Issue Reporter will show the following:Via
IssueDataProvider
, extensions can apply a template and specify data, which will populate the template in the issue description body or a previewable text box with extension data, like below.Additionally, we'll be adding a new activation event:
onIssueReporterOpened
which will activate the extension when the extension is selected in the extension selection section of the issue reporter. This ensures that extensions that are activated via means other thanonStartupFinished
will be able to contribute to the issue reporter via their API.Limitations
The main limitation in this API is that the information and extension data can only be sent via the API in
string
format.Additionally, at the moment, users would be unable to edit or modify the extension data that is sent. It's expected that users trust the extension to send the correct data and information and will be able to opt in or out of sending that extension data after previewing. However, if there are specific parts of the extension data that users would not want to send, they would only be able to send all or none.
The workaround is allowing the extension data text box to be editable, like the issue description. However, this may be an overload of information.
Another limitation is that only a single template can be provided, so users would break out of VS Code and have to report directly on GitHub if we want to direct them to one of the templates like below:
The text was updated successfully, but these errors were encountered: