diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 34142d003..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -name: Bug report -about: Report an issue with WXT -title: '' -labels: triage -assignees: '' ---- - -### Describe the bug - -A clear and concise description of what the bug is. - -### To Reproduce - -Share minimal reproduction. Examples of a minimal reproduction: - -- PR with a failing test case -- ZIP file containing a minimal WXT project (be sure to include your lockfile!!) - -> **_⚠️ If you don't upload a minimal reproduction, your issue will be closed until a reproduction is added._** -> -> Why? https://antfu.me/posts/why-reproductions-are-required - -Steps to reproduce the bug using the reproduction: - -1. Install dependencies: `pnpm i` -2. Start dev mode: `pnpm dev` -3. Click this... -4. Do that... -5. Etc... - -### Expected behavior - -A clear and concise description of what you expected to happen. - -### Screenshots - -If applicable, add screenshots to help explain your problem. - -### Environment - - - -``` -Paste output here -``` - -### Additional context - -Add any other context about the problem here, otherwise you can delete this section. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..05079366b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,74 @@ +name: "\U0001F41E Bug report" +description: Report an issue with WXT +labels: [pending-triage] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: bug-description + attributes: + label: Describe the bug + 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! + placeholder: I am doing ... What I expect is ... What actually happening is ... + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: | + Please provide a minimal reproduction. This can include: + + - A PR with a failing test case + - A link to a github repo + - Or a ZIP you upload to this issue. + + 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. + placeholder: Reproduction URL or ZIP + validations: + required: true + - type: textarea + id: reproduction-steps + attributes: + label: Steps to reproduce + 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. + placeholder: Run `npm install` followed by `npm run dev` + - type: textarea + id: system-info + attributes: + label: System Info + description: Output of `npx envinfo --system --browsers --binaries --npmPackages wxt,vite` + render: shell + placeholder: System, Binaries, Browsers + validations: + required: true + - type: dropdown + id: package-manager + attributes: + label: Used Package Manager + description: Select the used package manager + options: + - npm + - yarn + - pnpm + - bun + validations: + required: true + - type: checkboxes + id: checkboxes + attributes: + label: Validations + description: Before submitting the issue, please make sure you do the following + options: + - label: Read the [Contributing Guidelines](https://github.com/wxt-dev/wxt/blob/main/CONTRIBUTING.md). + required: true + - label: Read the [docs](https://wxt.dev/guide/installation.html). + required: true + - 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. + required: true + - 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). + required: true + - label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..316c600ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Discord Chat + url: https://discord.gg/ZFsZqGery9 + about: Ask questions and discuss with other WXT users in real time. + - name: Questions & Discussions + url: https://github.com/wxt-dev/wxt/discussions + about: Use GitHub discussions for message-board style questions and discussions.