From ea07dffdd5c1788e5b93f9f8539e787de09c6e25 Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Sat, 12 Oct 2024 19:13:51 +0200 Subject: [PATCH] chore(github): update issue templates --- .github/ISSUE_TEMPLATE/bug-v3.yml | 65 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 9 +++ .github/ISSUE_TEMPLATE/question.yml | 9 +++ 3 files changed, 83 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-v3.yml diff --git a/.github/ISSUE_TEMPLATE/bug-v3.yml b/.github/ISSUE_TEMPLATE/bug-v3.yml new file mode 100644 index 00000000..812ebdc0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-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 + 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. + - 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://github.com/my/reproduction + 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 diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 25f223ba..637242b9 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -6,6 +6,15 @@ body: attributes: value: | Before requesting a feature, please make sure that you have read through our [documentation](https://ui.nuxt.com) and existing [issues](https://github.com/nuxt/ui/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc). + - type: dropdown + id: version + attributes: + label: For what version of Nuxt UI are you suggesting this? + options: + - v2.x + - v3-alpha + validations: + required: true - type: textarea id: description attributes: diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index 1862bc39..ac082cf4 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -6,6 +6,15 @@ body: attributes: value: | Before asking a question, please make sure that you have read through our [documentation](https://ui.nuxt.com) and existing [issues](https://github.com/nuxt/ui/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc). + - type: dropdown + id: version + attributes: + label: For what version of Nuxt UI are you asking this question? + options: + - v2.x + - v3-alpha + validations: + required: true - type: textarea id: description attributes: