From 4f105c9e005e2ed13c90f49aa761967f4807f585 Mon Sep 17 00:00:00 2001 From: Tobias Diez Date: Wed, 28 Aug 2024 12:07:05 +0200 Subject: [PATCH] chore: add github bug report template (#769) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### ๐Ÿ”— Linked issue Closes #652. ### ๐Ÿ“š Description --- .github/ISSUE_TEMPLATE/bug-report.yml | 53 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ 2 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..591143c1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,53 @@ +name: "\U0001F41E Bug report" +description: Create a report to help us improve Nuxt +labels: ['type: bug'] +body: + - type: markdown + attributes: + value: " + ### Search for existing issues + + Please carefully [search for related issues (open and closed)](https://github.com/nuxt-modules/storybook/issues?q=is%3Aissue) and make sure you're not submitting a duplicate issue. + If you find anything that seems like the same bug, it's much better to comment on an existing thread than create a duplicate. + + ### Check nightly builds + + We are constantly improving the module and it's possible that the issue you're experiencing has already been fixed in the latest nightly build. + Please try to reproduce the issue with the [latest nightly build](https://storybook.nuxtjs.org/getting-started/setup#nightly-builds) and see if it still persists. + " + - 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: input + id: reproduction + attributes: + label: Reproduction + description: + It is important to provide a minimal reproduction of the issue you're experiencing. This makes it easier to understand the problem and to find a solution. + Issues without a reproduction might be closed immediately. + + The best way to create a minimal reproduction is by modifying the [Showcase example](https://github.com/nuxt-modules/storybook/tree/main/examples/showcase), + and open a PR with the minimal changes that reproduce the issue. + Alternatively, you can use the [StackBlitz template](https://stackblitz.com/github/nuxt-modules/storybook/tree/main/examples/starter) to create a minimal reproduction. + placeholder: URL to the 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. + Please try not to insert an image but copy paste the error text. + placeholder: Bug description + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: If applicable, add any other context about the problem here diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..227699ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: ๐Ÿ“š Documentation + url: https://storybook.nuxtjs.org/getting-started/setup + about: Check the documentation for usage and troubleshooting.