From 2531c8e66d69ac6415a31786c3e86522c8552aad Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Sat, 23 Sep 2023 14:26:18 +0200 Subject: [PATCH] chore(github): use issue forms --- .github/ISSUE_TEMPLATE/bug-report.md | 34 --------------- .github/ISSUE_TEMPLATE/bug-report.yml | 50 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.md | 23 ---------- .github/ISSUE_TEMPLATE/feature-request.yml | 20 +++++++++ .github/ISSUE_TEMPLATE/question.md | 11 ----- .github/ISSUE_TEMPLATE/question.yml | 14 ++++++ 7 files changed, 85 insertions(+), 69 deletions(-) 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 delete mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 5a27ead8..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: 🐛 Bug report -about: Report a bug to help us improve the module. -title: '' -labels: 'bug' -assignees: '' ---- - - - -### Version - -@nuxt/ui: -nuxt: - -### Reproduction - - - -### Description - - - -### Additional context - - diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..ae914d3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,50 @@ +name: "🐛 Bug report" +description: Report a bug to help us improve the module. +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Before reporting a bug, please make sure that you have read through our documentation and existing [issues](https://github.com/nuxt/ui/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc). + - type: textarea + id: env + attributes: + label: Environment + description: You can use `npx nuxi info` to fill this section + placeholder: Environment + validations: + required: true + - type: input + id: version + attributes: + label: Version + placeholder: v2.8.0 + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: Please provide a [**minimal reproduction**](https://nuxt.com/docs/community/reporting-bugs#create-a-minimal-reproduction) using this template https://stackblitz.com/edit/nuxt-ui. 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 5d676e3d..64d5e892 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,6 +3,6 @@ contact_links: - name: 📖 Documentation url: https://ui.nuxt.com/ about: Check the documentation for guides and examples. - - name: #️⃣ Discord + - name: 💬 Discord url: https://discord.nuxtjs.org/ about: Consider asking questions in the `#ui` channel. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 1c71c5ee..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: 🚀 Feature request -about: Suggest an idea or enhancement for the module. -title: '' -labels: 'enhancement' -assignees: '' ---- - - - -### Description - - - -### Additional context - - diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..b4a885c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,20 @@ +name: "🚀 Feature request" +description: Suggest an idea or enhancement for the module. +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Before requesting a feature, please make sure that you have read through our documentation and existing [issues](https://github.com/nuxt/ui/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc). + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of what you think would be an helpful addition to the module, 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. + validations: + required: true + - type: textarea + id: additonal + attributes: + label: Additional context + description: If applicable, add any other context or screenshots here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index c3f27528..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: 💬 Question -about: Ask a question about the module. -title: '' -labels: 'question' -assignees: '' ---- - - diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000..97986f92 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,14 @@ +name: "❓ Question" +description: Ask a question about the module. +labels: ["question"] +body: + - type: markdown + attributes: + value: | + Before asking a question, please make sure that you have read through our documentation and existing [issues](https://github.com/nuxt/ui/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc). + - type: textarea + id: description + attributes: + label: Description + validations: + required: true