Skip to content

Commit

Permalink
Merge pull request #3815 from MicrosoftEdge/victorhuangwq/updatetemplate
Browse files Browse the repository at this point in the history
Using form template for bug report and feature request
  • Loading branch information
victorhuangwq authored Oct 5, 2023
2 parents a1ec01e + 07e9c39 commit d90f3d4
Show file tree
Hide file tree
Showing 8 changed files with 219 additions and 76 deletions.
125 changes: 125 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug report form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
name: Report a problem/bug
title: '[Problem/Bug]: '
description: Report if something is not working
labels: ["bug"]
body:
- type: markdown
attributes:
value:
Thanks for taking time to fill up the bug report! Here is [a good bug report](https://github.com/MicrosoftEdge/WebView2Feedback/issues/3648) that will help us in identifying the issue.
- id: what-happened
type: textarea
attributes:
description: Describe the issue you encountered. Callstacks and error messages are helpful.
label: What happened?
validations:
required: true
- id: importance
type: dropdown
attributes:
label: Importance
description: How important is this bug to your app?
multiple: false
options:
- ----Please select----
- Blocking. My app's basic functions are not working due to this issue.
- Important. My app's user experience is significantly compromised.
- Moderate. My app's user experience is affected, but still usable.
validations:
required: true
- id: runtime-channel
type: dropdown
attributes:
label: Runtime Channel
description: Are you seeing this issue in stable release or prerelease of WebView2 runtime?
multiple: true
options:
- Stable release (WebView2 Runtime)
- Prerelease (Edge Canary/Dev/Beta)
validations:
required: true
- type: markdown
attributes:
value: |
**Tip:** it's recommended to test your web content in the WebView2 control against [Microsoft Edge Insider (preview) Channels (Beta, Dev, or Canary)](https://www.microsoft.com/en-us/edge/download/insider?form=MA13FJ). For more information please check out [testing app for forward-compatibility](https://learn.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution#test-your-app-for-forward-compatibility).
- id: runtime-version
type: input
attributes:
description: Which runtime version are you using? Instructions [here](https://github.com/MicrosoftEdge/WebView2Feedback/blob/victorhuangwq/updatetemplate/diagnostics/version.md)
label: Runtime Version
placeholder: (eg. 114.0.1823.79)
- id: sdk-version
type: input
attributes:
description: Which SDK version are you using? Instructions [here](https://github.com/MicrosoftEdge/WebView2Feedback/blob/victorhuangwq/updatetemplate/diagnostics/version.md)
label: SDK Version
placeholder: (eg. 1.0.1905-prerelease)

- id: framework
type: dropdown
attributes:
description: What UI framework are you using?
label: Framework
options:
- ----Please select----
- WPF
- Win32
- Winforms
- WinUI2/UWP
- WinUI3/WinAppSDK
- Unity Plugin
- Other
validations:
required: true
- id: os
type: dropdown
attributes:
description: Which operating system are you seeing this issue with?
label: Operating System
multiple: true
options:
- Windows 10
- Windows 11
- Earlier than Windows 10 (deprecated)
- Windows Server
- Xbox
- Hololens
- Other
validations:
required: true

- id: os-version
type: input
attributes:
description: Version can be found in System > About or System Information
label: OS Version
placeholder: (e.g. 22621.2283 or 10.0.22621)
validations:
required: false
- id: repro-steps
type: textarea
attributes:
description: What are the steps needed to reproduce the bug? Describe the expected behavior against the actual behavior.
label: Repro steps
validations:
required: true
- id: regression
type: dropdown
attributes:
description: Was this working before, but has regressed?
label: Regression
options:
- No, this never worked
- Regression in newer Runtime
- Regression in newer SDK
- Don't know
validations:
required: true
- id: last-working-version
type: input
attributes:
description: If this is a regression, what was the last working version of SDK and Runtime?
label: Last working version (if regression)
placeholder: (e.g. SDK 1.0.1774.30, Runtime 114.0.1823.32)
validations:
required: false
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature request form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Feature Request
title: "[Feature]: "
description: Share your idea for a new feature/API enhancement
labels: ["feature request"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request. Here is an example of a [good feature request](https://github.com/MicrosoftEdge/WebView2Feedback/issues/3683)
- type: textarea
id: feature-need
attributes:
label: Describe the feature/enhancement you need
description: Describe what you want to happen, or what problem you are seeing without this feature.
placeholder: I need to do xyz when ... but I'm having trouble achieving this because...
validations:
required: true

- type: textarea
id: usecases
attributes:
label: The scenario/use case where you would use this feature
placeholder: e.g. our user needs to print out a report based on a pre-defined template. We need to set the print options in a dialog box with values defined in the template.
validations:
required: true

- type: dropdown
id: importance
attributes:
label: How important is this request to you?
options:
- ----Please select----
- Critical. My app's basic functions wouldn't work without it.
- Impactful. My app's user experience would be significantly compromised without it.
- Nice to have. There are other ways to tackle this, but having official API support would be beneficial.
validations:
required: true
- type: markdown
attributes:
value: |
## ---Helpful additional info---
- type: textarea
id: suggested-implementation
attributes:
label: Suggested implementation
description: If you have solution ideas you'd like to suggest, please describe here.
placeholder: I'd like to suggest...
validations:
required: false
- type: textarea
id: app-background
attributes:
label: What does your app do? Is there a pending deadline for this request?
description: If you haven't shared before, it would be helpful to understand what your app does, how WebView2 is used, and if there's any pending timeline.
placeholder: e.g. our app use WebView2 to handle form submission and printing in hospital kiosks. We need to release in this December.
validations:
required: false

- type: markdown
attributes:
value: |
## ---How to add a '+1' reply for this request---
We welcome other developers who saw the original post to indicate they also want this feature. Please reply with these info to help us prioritize:
- Your use cases/scenario as it may differ from the original post
- How important is this request to you?
- Additionally, any context such as what does your app do, and any pending timeline
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
contact_links:
- name: WebView2 Questions and Answers
url: https://github.com/MicrosoftEdge/WebView2Feedback/discussions/new?category=q-a
about: Ask the community for help
- name: WebView2 Tips and Tricks
url: https://github.com/MicrosoftEdge/WebView2Feedback/discussions/new?category=tips-and-tricks
about: Share tips and tricks you've learned for using WebView2
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/feature---api-request.md

This file was deleted.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/tip-.md

This file was deleted.

18 changes: 18 additions & 0 deletions diagnostics/version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Figuring out SDK and runtime version

SDK and runtime verion number of WebView2 is helpful for someone who is trying to reproduce a bug. The follow options are ways for you to obtain the version numbers of the host app.

### Option 1: Use WebView2 Utilities (SDK and runtime)
An easy way to obtain the SDK and runtime version for any host app that is currently running, is to use [WebView2Utilities](https://github.com/david-risney/WebView2Utilities).

### Option 2a: Check NuGet Package Manager (SDK only)
If you are a developer for the WebView2 application, on Visual Studio Code, go to `Tools > NuGet Package Manager > Manage NuGet Packages for Solution`, and see the SDK version that is being used for the project

### Option 2b: Check WebView2 child process of host app (Runtime only)
For any application, to check the which WebView2 runtime is being used, do the following:

1. Open Task Manager
2. Right click on the WebView2 process of the application you are interested in
3. Click on Open File Location

The directory of the file location is the WebView2 runtime version

0 comments on commit d90f3d4

Please sign in to comment.