From f36fb9cd05372faa5d5b3449b4a67009e0a5bb51 Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Thu, 19 Jan 2023 08:36:38 +0000 Subject: [PATCH] chore: update issue templates --- .github/ISSUE_TEMPLATE/bug-report-2.x.md | 49 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug-report.md | 47 --------------------- .github/ISSUE_TEMPLATE/bug-report.yml | 49 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 15 +++---- .github/ISSUE_TEMPLATE/feature-request.md | 26 ------------ .github/ISSUE_TEMPLATE/feature-request.yml | 37 ++++++++++++++++ 6 files changed, 143 insertions(+), 80 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report-2.x.md delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report-2.x.md b/.github/ISSUE_TEMPLATE/bug-report-2.x.md new file mode 100644 index 000000000000..ff8132287948 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report-2.x.md @@ -0,0 +1,49 @@ +name: "\U0001F41E Bug report (Nuxt 2)" +description: Create a report to help us improve Nuxt +labels: ["pending triage", "2.x"] +body: + - type: markdown + attributes: + value: | + Please carefully read the contribution docs before creating a bug report + ๐Ÿ‘‰ https://nuxt.com/docs/community/reporting-bugs + + Please use a template below to create a minimal reproduction + ๐Ÿ‘‰ https://stackblitz.com/github/nuxt/starter/tree/v2 + ๐Ÿ‘‰ https://codesandbox.io/p/github/nuxt/starter/v2 + - type: textarea + id: bug-env + attributes: + label: Environment + description: You can use `npx envinfo --system --npmPackages '{nuxt,@nuxt/*}' --binaries --browsers` to fill this section + placeholder: Environment + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: Please provide a link to a repo that can reproduce the problem you ran into. A [**minimal reproduction**](https://nuxt.com/docs/community/reporting-bugs#create-a-minimal-reproduction) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided we might close it. + placeholder: Reproduction + validations: + required: true + - 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: Bug description + validations: + required: true + - type: textarea + id: additonal + attributes: + label: Additional context + description: If applicable, add any other context about the problem here + - type: textarea + id: logs + attributes: + label: Logs + description: | + Optional if provided reproduction. Please try not to insert an image but copy paste the log text. + render: shell-script diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 6759cb02bb70..000000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: ๐Ÿšจ Bug report | Bug ๆไบค -about: Report a bug report to help us improve Nuxt. -title: '' -labels: 'bug-report' -assignees: '' - ---- - - - -### Versions - -- nuxt: -- node: - -### Reproduction - - - -
-Additional Details -
- -
- -### Steps to reproduce - - -### What is Expected? - - -### What is actually happening? diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000000..bbea7f97464b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,49 @@ +name: "\U0001F41E Bug report" +description: Create a report to help us improve Nuxt +labels: ["pending triage", "3.x"] +body: + - type: markdown + attributes: + value: | + Please carefully read the contribution docs before creating a bug report + ๐Ÿ‘‰ https://nuxt.com/docs/community/reporting-bugs + + Please use a template below to create a minimal reproduction + ๐Ÿ‘‰ https://stackblitz.com/github/nuxt/starter/tree/v3-stackblitz + ๐Ÿ‘‰ https://codesandbox.io/p/github/nuxt/starter/v3-codesandbox + - type: textarea + id: bug-env + attributes: + label: Environment + description: You can use `npx nuxi info` to fill this section + placeholder: Environment + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: Please provide a link to a repo that can reproduce the problem you ran into. A [**minimal reproduction**](https://nuxt.com/docs/community/reporting-bugs#create-a-minimal-reproduction) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided we might close it. + placeholder: Reproduction + validations: + required: true + - 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: Bug description + validations: + required: true + - type: textarea + id: additonal + attributes: + label: Additional context + description: If applicable, add any other context about the problem here + - type: textarea + id: logs + attributes: + label: Logs + description: | + Optional if provided reproduction. Please try not to insert an image but copy paste the log text. + render: shell-script diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3292c4e1a94e..7f6ee9646cef 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,10 +1,11 @@ blank_issues_enabled: true contact_links: - - name: Issues using `@nuxt/bridge` - url: https://github.com/nuxt/framework - about: | - Please use GitHub Discussions for other issues and asking questions about Nuxt 3 and Bridge. - - name: โ—๏ธ All other issues | ๅ…ถไป–้—ฎ้ข˜ + - name: ๐Ÿ“š Nuxt 3 Documentation + url: https://nuxt.com/docs/ + about: Check the documentation for usage of Nuxt 3 + - name: ๐Ÿ“š Nuxt 2 Documentation + url: https://nuxtjs.org/ + about: Check the documentation for usage of Nuxt 2 + - name: ๐Ÿ’ฌ Discussions url: https://github.com/nuxt/nuxt.js/discussions - about: | - Please use GitHub Discussions for other issues and asking questions. + about: Use discussions if you have another issue, an idea for improvement or for asking questions. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 5ed9ed3fd2a1..000000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: ๐Ÿ™‹ Feature request | ๆ–ฐๅŠŸ่ƒฝๆๆกˆ -about: Suggest an idea or enhancement for Nuxt. -title: '' -labels: 'feature-request' -assignees: '' - ---- - - - -### Is your feature request related to a problem? Please describe. - - - -### Describe the solution you'd like - - - -### Describe alternatives you've considered - - - -### Additional context - - diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000000..0549dbbfd0cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,37 @@ +name: "๐Ÿš€ Feature request" +description: Suggest a feature that will improve Nuxt +labels: ["pending triage"] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this feature request! + + Please carefully read the contribution docs before suggesting a new feature + ๐Ÿ‘‰ https://nuxt.com/docs/community/contribution/#creating-an-issue + - type: textarea + id: feature-description + attributes: + label: Describe the feature + description: A clear and concise description of what you think would be a helpful addition to Nuxt, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link. + placeholder: Feature description + validations: + required: true + - type: checkboxes + id: additional-info + attributes: + label: Additional information + description: Additional information that helps us decide how to proceed. + options: + - label: Would you be willing to help implement this feature? + - label: Could this feature be implemented as a module? + - type: checkboxes + id: required-info + attributes: + label: Final checks + description: Before submitting, please make sure you do the following + options: + - label: Read the [contribution guide](https://nuxt.com/docs/community/contribution). + required: true + - label: Check existing [discussions](https://github.com/nuxt/nuxt.js/discussions) and [issues](https://github.com/nuxt/nuxt.js/issues). + required: true