Skip to content

Commit 3198234

Browse files
committed
Migrate bug report to a GitHub form template
1 parent 7b849b8 commit 3198234

File tree

3 files changed

+82
-50
lines changed

3 files changed

+82
-50
lines changed

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

-50
This file was deleted.

Diff for: .github/ISSUE_TEMPLATE/bug_report.yml

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: "\U0001F41E Bug report"
2+
description: Report an issue with WXT
3+
labels: [pending-triage]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
- type: textarea
10+
id: bug-description
11+
attributes:
12+
label: Describe the bug
13+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
14+
placeholder: I am doing ... What I expect is ... What actually happening is ...
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: reproduction
19+
attributes:
20+
label: Reproduction
21+
description: |
22+
Please provide a minimal reproduction. This can include:
23+
24+
- A PR with a failing test case
25+
- A link to a github repo
26+
- Or a ZIP you upload to this issue.
27+
28+
A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required ([Why?](https://antfu.me/posts/why-reproductions-are-required)). If a report is vague (e.g. just a generic error message) and has no reproduction or a partial reproduction, it will be closed immediately and labeled with as "needs-reproduction". Once a reproduction is provided, it will be re-opened.
29+
placeholder: Reproduction URL or ZIP
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: reproduction-steps
34+
attributes:
35+
label: Steps to reproduce
36+
description: Please provide any reproduction steps that may need to be described. E.g. if it happens only when running the dev or build script make sure it's clear which one to use.
37+
placeholder: Run `npm install` followed by `npm run dev`
38+
- type: textarea
39+
id: system-info
40+
attributes:
41+
label: System Info
42+
description: Output of `npx envinfo --system --browsers --binaries --npmPackages wxt,vite`
43+
render: shell
44+
placeholder: System, Binaries, Browsers
45+
validations:
46+
required: true
47+
- type: dropdown
48+
id: package-manager
49+
attributes:
50+
label: Used Package Manager
51+
description: Select the used package manager
52+
options:
53+
- npm
54+
- yarn
55+
- pnpm
56+
- bun
57+
validations:
58+
required: true
59+
- type: checkboxes
60+
id: checkboxes
61+
attributes:
62+
label: Validations
63+
description: Before submitting the issue, please make sure you do the following
64+
options:
65+
- label: Read the [Contributing Guidelines](https://github.com/wxt-dev/wxt/blob/main/CONTRIBUTING.md).
66+
required: true
67+
- label: Read the [docs](https://wxt.dev/guide/installation.html).
68+
required: true
69+
- label: Check that there isn't [already an issue](https://github.com/wxt-dev/wxt/issues) that reports the same bug to avoid creating a duplicate.
70+
required: true
71+
- label: Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/wxt-dev/wxt/discussions) or join our [Discord Chat Server](https://discord.gg/ZFsZqGery9).
72+
required: true
73+
- label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
74+
required: true

Diff for: .github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discord Chat
4+
url: https://discord.gg/ZFsZqGery9
5+
about: Ask questions and discuss with other WXT users in real time.
6+
- name: Questions & Discussions
7+
url: https://github.com/wxt-dev/wxt/discussions
8+
about: Use GitHub discussions for message-board style questions and discussions.

0 commit comments

Comments
 (0)