From 7597b1dc065530e9978b13d4fb6843228ad3ea51 Mon Sep 17 00:00:00 2001 From: OrbisK <37191683+OrbisK@users.noreply.github.com> Date: Fri, 4 Oct 2024 13:26:28 +0000 Subject: [PATCH 1/5] docs: add separate v3 issue template --- .github/ISSUE_TEMPLATE/bug-report.v3.yml | 65 ++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.v3.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.v3.yml b/.github/ISSUE_TEMPLATE/bug-report.v3.yml new file mode 100644 index 0000000000..cbdd94671e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.v3.yml @@ -0,0 +1,65 @@ +name: "🐛 Bug report (v3)" +description: Report a bug to help us improve the module (v3 only). +labels: ["triage", "bug", "v3"] +body: + - type: markdown + attribues: + value: | + > [!IMPORTANT] + > As Nuxt UI v3 is currently in alpha, we recommend thorough testing before using it in production environments. We're actively working on stabilization and welcome feedback from early adopters to improve the library. + - type: markdown + attributes: + value: | + Before reporting a bug, please make sure that you have read through our [v3 documentation](https://ui3.nuxt.dev/) and existing [issues](https://github.com/nuxt/ui/issues?q=is%3Aissue%20is%3Aopen%20sort%3Aupdated-desc%20label%3Av3). + - type: textarea + id: env + attributes: + label: Environment + description: You can use `npx nuxi info` to fill this section + placeholder: | + - Operating System: `Darwin` + - Node Version: `v18.16.0` + - Nuxt Version: `3.7.3` + - CLI Version: `3.8.4` + - Nitro Version: `2.6.3` + - Package Manager: `pnpm@8.7.4` + - Builder: `-` + - User Config: `-` + - Runtime Modules: `-` + - Build Modules: `-` + validations: + required: true + - type: input + id: version + attributes: + label: Version + placeholder: v3.0.0-alpha.5 + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: Please provide a reproduction link. A minimal [reproduction is required](https://antfu.me/posts/why-reproductions-are-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 "needs reproduction" label. If no reproduction is provided we might close it. + placeholder: https://stackblitz.com/edit/nuxt-ui + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + 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. + validations: + required: true + - type: textarea + id: additonal + attributes: + label: Additional context + description: If applicable, add any other context or screenshots 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 From e6c8cadc1f95e2332337bd3bb2023173f527ddc8 Mon Sep 17 00:00:00 2001 From: OrbisK <37191683+OrbisK@users.noreply.github.com> Date: Fri, 4 Oct 2024 13:29:21 +0000 Subject: [PATCH 2/5] docs: fix typo --- .github/ISSUE_TEMPLATE/bug-report.v3.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.v3.yml b/.github/ISSUE_TEMPLATE/bug-report.v3.yml index cbdd94671e..f7dcf956c7 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.v3.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.v3.yml @@ -5,8 +5,8 @@ body: - type: markdown attribues: value: | - > [!IMPORTANT] - > As Nuxt UI v3 is currently in alpha, we recommend thorough testing before using it in production environments. We're actively working on stabilization and welcome feedback from early adopters to improve the library. + > [!IMPORTANT] + > As Nuxt UI v3 is currently in alpha, we recommend thorough testing before using it in production environments. We're actively working on stabilization and welcome feedback from early adopters to improve the library. - type: markdown attributes: value: | From d1cf25421743fec398b008a9a6be3073d1e1144a Mon Sep 17 00:00:00 2001 From: OrbisK <37191683+OrbisK@users.noreply.github.com> Date: Fri, 4 Oct 2024 13:29:54 +0000 Subject: [PATCH 3/5] docs: fix typo --- .github/ISSUE_TEMPLATE/bug-report.v3.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.v3.yml b/.github/ISSUE_TEMPLATE/bug-report.v3.yml index f7dcf956c7..6d6030114a 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.v3.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.v3.yml @@ -3,7 +3,7 @@ description: Report a bug to help us improve the module (v3 only). labels: ["triage", "bug", "v3"] body: - type: markdown - attribues: + attributes: value: | > [!IMPORTANT] > As Nuxt UI v3 is currently in alpha, we recommend thorough testing before using it in production environments. We're actively working on stabilization and welcome feedback from early adopters to improve the library. From 76d72ad1a034f65b0071b096b781dc6bf04e0859 Mon Sep 17 00:00:00 2001 From: OrbisK <37191683+OrbisK@users.noreply.github.com> Date: Fri, 4 Oct 2024 13:36:47 +0000 Subject: [PATCH 4/5] docs: rename v3 issue template to respect ordering --- .github/ISSUE_TEMPLATE/{bug-report.v3.yml => bug-v3.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{bug-report.v3.yml => bug-v3.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/bug-report.v3.yml b/.github/ISSUE_TEMPLATE/bug-v3.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/bug-report.v3.yml rename to .github/ISSUE_TEMPLATE/bug-v3.yml From fb4b01f84c4ffed6cf1438a8c5c2ecbb5d298a45 Mon Sep 17 00:00:00 2001 From: OrbisK <37191683+OrbisK@users.noreply.github.com> Date: Sat, 5 Oct 2024 15:24:46 +0000 Subject: [PATCH 5/5] chore: remove stackblitz url --- .github/ISSUE_TEMPLATE/bug-v3.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-v3.yml b/.github/ISSUE_TEMPLATE/bug-v3.yml index 6d6030114a..812ebdc09e 100644 --- a/.github/ISSUE_TEMPLATE/bug-v3.yml +++ b/.github/ISSUE_TEMPLATE/bug-v3.yml @@ -41,7 +41,7 @@ body: attributes: label: Reproduction description: Please provide a reproduction link. A minimal [reproduction is required](https://antfu.me/posts/why-reproductions-are-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 "needs reproduction" label. If no reproduction is provided we might close it. - placeholder: https://stackblitz.com/edit/nuxt-ui + placeholder: https://github.com/my/reproduction validations: required: true - type: textarea