Skip to content

Commit f97bdc6

Browse files
mohamedmansourmohamedmansour
authored
Add GitHub issue forms (#328)
1 parent b513efb commit f97bdc6

6 files changed

Lines changed: 238 additions & 4 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: Bug report
2+
description: Report a reproducible problem in WebUI.
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for helping improve WebUI. Before opening a bug, please read the [bug reporting guidance](https://github.com/microsoft/webui/blob/main/CONTRIBUTING.md#bugs).
10+
11+
Do not report security vulnerabilities here. Follow the [security policy](https://github.com/microsoft/webui/security/policy) instead.
12+
- type: checkboxes
13+
id: preflight
14+
attributes:
15+
label: Before filing
16+
options:
17+
- label: I searched existing issues and did not find a duplicate.
18+
required: true
19+
- label: This is not a security vulnerability.
20+
required: true
21+
- type: dropdown
22+
id: area
23+
attributes:
24+
label: Area
25+
description: Which part of WebUI does this affect?
26+
options:
27+
- CLI
28+
- Parser
29+
- Handler
30+
- Protocol
31+
- FFI
32+
- WebUI Framework package
33+
- WebUI Router package
34+
- Documentation
35+
- Examples
36+
- Integrations
37+
- Performance
38+
- Not sure / other
39+
- type: input
40+
id: summary
41+
attributes:
42+
label: Summary
43+
description: Briefly describe the problem.
44+
placeholder: WebUI fails to render nested route content when...
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: reproduction
49+
attributes:
50+
label: Minimal reproduction
51+
description: If available, provide a sample repository, small code snippet, or minimal template that reproduces the issue.
52+
placeholder: Paste the smallest example that reproduces the problem.
53+
- type: textarea
54+
id: steps
55+
attributes:
56+
label: Steps to reproduce
57+
description: List the exact commands or actions needed to reproduce the problem.
58+
placeholder: |
59+
1. Run `...`
60+
2. Open `...`
61+
3. Observe `...`
62+
validations:
63+
required: true
64+
- type: textarea
65+
id: expected
66+
attributes:
67+
label: Expected behavior
68+
description: What did you expect to happen?
69+
- type: textarea
70+
id: actual
71+
attributes:
72+
label: Actual behavior
73+
description: What happened instead?
74+
- type: textarea
75+
id: environment
76+
attributes:
77+
label: Environment
78+
description: Include relevant versions and the command you ran.
79+
value: |
80+
- OS:
81+
- Rust version:
82+
- Node.js version:
83+
- WebUI package or CLI version:
84+
- Command:
85+
- type: textarea
86+
id: logs
87+
attributes:
88+
label: Logs or terminal output
89+
description: Paste relevant logs, stack traces, or terminal output.
90+
render: shell

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Support guidance
4+
url: https://github.com/microsoft/webui/blob/main/SUPPORT.md
5+
about: Read the support policy before opening a support request.
6+
- name: Security vulnerability
7+
url: https://github.com/microsoft/webui/security/policy
8+
about: Report suspected vulnerabilities privately through the security policy.

‎.github/ISSUE_TEMPLATE/documentation_issue.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Documentation need
2+
description: Report missing, confusing, or incorrect WebUI documentation.
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for helping improve WebUI documentation. Before opening an issue, please read the [documentation issue guidance](https://github.com/microsoft/webui/blob/main/CONTRIBUTING.md#documentation-issues).
10+
- type: checkboxes
11+
id: preflight
12+
attributes:
13+
label: Before filing
14+
options:
15+
- label: I searched existing issues and did not find a duplicate.
16+
required: true
17+
- type: dropdown
18+
id: area
19+
attributes:
20+
label: Area
21+
description: Which documentation area needs attention?
22+
options:
23+
- Getting started
24+
- CLI
25+
- Template syntax
26+
- Components and interactivity
27+
- Routing
28+
- State management
29+
- Handlers and integrations
30+
- Plugins
31+
- Performance
32+
- Examples
33+
- API reference
34+
- Not sure / other
35+
- type: input
36+
id: location
37+
attributes:
38+
label: Page, section, or workflow
39+
description: Link to the page or name the workflow, if you know it.
40+
placeholder: https://microsoft.github.io/webui/guide/...
41+
- type: textarea
42+
id: problem
43+
attributes:
44+
label: What is the documentation issue?
45+
description: Describe what was confusing, missing, incorrect, or hard to find.
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: expected
50+
attributes:
51+
label: What did you expect to find?
52+
description: Describe the information or example you expected.
53+
- type: textarea
54+
id: helpful-information
55+
attributes:
56+
label: What information would help?
57+
description: Include any details that would make the documentation clearer.
58+
- type: textarea
59+
id: suggested-wording
60+
attributes:
61+
label: Suggested wording or examples
62+
description: If you have a suggested fix, paste it here.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Feature request
2+
description: Request a WebUI capability, API, CLI behavior, or workflow improvement.
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for helping shape WebUI. Before opening a feature request, please read the [feature request guidance](https://github.com/microsoft/webui/blob/main/CONTRIBUTING.md#feature-requests).
10+
- type: checkboxes
11+
id: preflight
12+
attributes:
13+
label: Before filing
14+
options:
15+
- label: I searched existing issues and did not find a duplicate.
16+
required: true
17+
- type: dropdown
18+
id: area
19+
attributes:
20+
label: Area
21+
description: Which part of WebUI would this improve?
22+
options:
23+
- CLI
24+
- Parser
25+
- Handler
26+
- Protocol
27+
- FFI
28+
- WebUI Framework package
29+
- WebUI Router package
30+
- Documentation
31+
- Examples
32+
- Integrations
33+
- Performance
34+
- Not sure / other
35+
- type: textarea
36+
id: problem
37+
attributes:
38+
label: Problem or need
39+
description: What are you trying to solve, and why does it matter?
40+
placeholder: I want to...
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: audience
45+
attributes:
46+
label: Who would benefit?
47+
description: Describe the users, projects, or workflows this would help.
48+
- type: textarea
49+
id: desired-outcome
50+
attributes:
51+
label: Desired outcome
52+
description: Describe the API, CLI behavior, runtime behavior, or workflow you would like.
53+
- type: textarea
54+
id: example
55+
attributes:
56+
label: Concrete example
57+
description: Show the desired API, CLI command, template, or workflow.
58+
- type: textarea
59+
id: constraints
60+
attributes:
61+
label: Constraints
62+
description: Note any performance, security, compatibility, migration, or ecosystem constraints.
63+
placeholder: Performance, security, compatibility, migration, or other constraints.
64+
- type: textarea
65+
id: alternatives
66+
attributes:
67+
label: Alternatives or workarounds
68+
description: What alternatives or workarounds have you considered?

‎CONTRIBUTING.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ If a maintainer invites a pull request for a focused change, most contributions
1414
- Feature requests that explain the need and expected outcome.
1515
- Documentation issues that identify confusing, missing, or incorrect guidance.
1616

17-
Before opening an issue, search the [existing issues](https://github.com/microsoft/webui/issues) to avoid duplicates. Use one issue per bug, feature, or documentation need.
17+
Before opening an issue, search the [existing issues](https://github.com/microsoft/webui/issues) to avoid duplicates. Use one issue per bug, feature, or documentation need. Provide as much detail as you can, but do not let a missing version number or code sample stop you from reporting a useful issue.
18+
19+
Start from the [GitHub issue template chooser](https://github.com/microsoft/webui/issues/new/choose), or use a matching form directly:
20+
21+
- [Report a bug](https://github.com/microsoft/webui/issues/new?template=bug_report.yml)
22+
- [Request a feature](https://github.com/microsoft/webui/issues/new?template=feature_request.yml)
23+
- [Report a documentation need](https://github.com/microsoft/webui/issues/new?template=documentation_issue.yml)
1824

1925
## Bugs
2026

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ WebUI is still in active development. We are not accepting unsolicited pull requ
7070

7171
| Need | Where to go |
7272
|------|-------------|
73-
| Report a bug | [`CONTRIBUTING.md#bugs`](CONTRIBUTING.md#bugs) |
74-
| Request a feature | [`CONTRIBUTING.md#feature-requests`](CONTRIBUTING.md#feature-requests) |
75-
| Report a documentation need | [`CONTRIBUTING.md#documentation-issues`](CONTRIBUTING.md#documentation-issues) |
73+
| Report a bug | [Choose an issue template](https://github.com/microsoft/webui/issues/new/choose) |
74+
| Request a feature | [Choose an issue template](https://github.com/microsoft/webui/issues/new/choose) |
75+
| Report a documentation need | [Choose an issue template](https://github.com/microsoft/webui/issues/new/choose) |
7676
| Get support guidance | [`SUPPORT.md`](SUPPORT.md) |
7777
| Report a security issue | [`SECURITY.md`](SECURITY.md) |
7878

0 commit comments

Comments
 (0)