From f6ef842ef32cafaaa01c515f39567403c594cd69 Mon Sep 17 00:00:00 2001 From: Smultar Date: Sat, 30 Dec 2023 23:39:56 -0600 Subject: [PATCH] Implement #670. Co-authored-by: Smultar Co-authored-by: Zakher Masri <46135573+zaaakher@users.noreply.github.com> --- .github/DISCUSSION_TEMPLATE/help.yml | 24 +++++ .github/DISCUSSION_TEMPLATE/ideas.yml | 60 ++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 46 ---------- .github/ISSUE_TEMPLATE/bug_report.yml | 107 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature_request.md | 35 ------- 6 files changed, 199 insertions(+), 81 deletions(-) create mode 100644 .github/DISCUSSION_TEMPLATE/help.yml create mode 100644 .github/DISCUSSION_TEMPLATE/ideas.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/DISCUSSION_TEMPLATE/help.yml b/.github/DISCUSSION_TEMPLATE/help.yml new file mode 100644 index 000000000..3904202dc --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/help.yml @@ -0,0 +1,24 @@ +title: '[Help]: ' +labels: ['demonstration'] +body: + - type: textarea + attributes: + label: Summary + description: What do you need help with? + validations: + required: true + + - type: textarea + attributes: + label: Additional information + description: Any code snippets, error messages, or dependency details that may be related? + render: js + validations: + required: false + + - type: input + attributes: + label: CodeSandbox example + description: A link to a minimal reproduction is helpful for collaborative debugging! + validations: + required: false diff --git a/.github/DISCUSSION_TEMPLATE/ideas.yml b/.github/DISCUSSION_TEMPLATE/ideas.yml new file mode 100644 index 000000000..2073331b3 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/ideas.yml @@ -0,0 +1,60 @@ +title: '[Feat]: ' +labels: ['feature request'] +body: + - type: markdown + attributes: + value: | + **Thanks :heart: for taking the time to fill out this feature request!** + We kindly ask that you search to see if an issue [already exists](https://github.com/davidjerleke/embla-carousel/issues?q=is%3Aissue+sort%3Acreated-desc+) for your feature. + + We are happy to accept contributions from our users. For more details see [here](https://github.com/davidjerleke/embla-carousel/blob/master/CONTRIBUTING.md#new-features). + + - type: checkboxes + id: relations + attributes: + label: Which variants of Embla Carousel are relevant to this request? + description: Check all that apply. + options: + - label: embla-carousel **(Core)** + - label: embla-carousel-react + - label: embla-carousel-vue + - label: embla-carousel-svelte + - label: embla-carousel-autoplay + - label: embla-carousel-solid + - label: embla-carousel-auto-height + - label: embla-carousel-class-names + - label: embla-carousel-docs **(Documentation)** + - label: embla-carousel-docs **(Generator)** + + - type: textarea + id: feature-description + attributes: + label: Feature description + description: Tell us about your feature request + placeholder: 'I think this feature would be great because...' + value: 'Describe your feature request...' + validations: + required: true + + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other context about the feature here. + placeholder: ex. screenshots, stack traces, related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. + value: 'Additional details here...' + validations: + required: false + + - type: checkboxes + id: terms + attributes: + label: Before submitting + description: By submitting this issue, you agree to follow our [Contribution Guidelines](https://github.com/davidjerleke/embla-carousel/blob/master/CONTRIBUTING.md). + options: + - label: I've made research efforts and searched the documentation + required: true + - label: I've searched for existing issues + required: true + - label: I agree to follow this project's Contribution Guidelines for feature requests + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index ca85502d7..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' ---- - -### Bug is related to - -- [ ] embla-carousel (core package) -- [ ] embla-carousel-react -- [ ] embla-carousel-vue -- [ ] embla-carousel-svelte -- [ ] embla-carousel-autoplay -- [ ] embla-carousel-auto-height -- [ ] embla-carousel-class-names -- [ ] embla-carousel-docs (documentation) -- [ ] embla-carousel-docs (generator) - -### Embla Carousel version - -- v0.0.0 - -### Describe the bug - -- A clear and concise description of what the bug is. - -### CodeSandbox - -- The link to a CodeSandbox that demonstrates the bug clearly. - -### Steps to reproduce - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -### Expected behavior - -- A clear and concise description of what you expected to happen. - -### Additional context - -- Add any other context about the problem here, like screenshots or similar. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..b04c461ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,107 @@ +name: Bug Report +description: Submit a bug report to help us improve, or to simply point out something that's broken. +title: '[Bug]: ' +labels: ['bug'] +assignees: ['davidjerleke'] +body: + - type: markdown + attributes: + value: | + **Thanks :heart: for taking the time to fill out this bug report!** + We kindly ask that you search to see if an issue [already exists](https://github.com/davidjerleke/embla-carousel/issues?q=is%3Aissue+sort%3Acreated-desc+) for your bug. + If you're unsure if this is a bug or not, please create a [new discussion](https://github.com/davidjerleke/embla-carousel/discussions/new?category=q-a) instead. + + We are happy to accept contributions from our users. For more details see [here](https://github.com/davidjerleke/embla-carousel/blob/master/CONTRIBUTING.md#bug-reports). + + - type: input + id: version + attributes: + label: Version + description: Which version of Embla Carousel are you using? + placeholder: ex. v8.0.0 + validations: + required: false + + - type: input + id: codesandbox + attributes: + label: CodeSandbox + description: A link to a CodeSandbox that reproduces the issue. **Skipping this/providing an invalid link will result in the issue being closed**. + placeholder: ex. https://codesandbox.io/s/fancy-example-smu + validations: + required: false + + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - All of the above + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: A step-by-step description of how to reproduce the bug. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. See error + value: 'The bug occurs when I...' + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: What should have happened? + placeholder: Tell us what you expected to happen! + value: 'Fancy feature should have...' + validations: + required: true + + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other context about the problem here. + placeholder: ex. screenshots, stack traces, related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. + value: 'I have also tried...' + validations: + required: false + + - type: checkboxes + id: relations + attributes: + label: Which variants of Embla Carousel are you using? + description: Check all that apply. + options: + - label: embla-carousel **(Core)** + - label: embla-carousel-react + - label: embla-carousel-vue + - label: embla-carousel-svelte + - label: embla-carousel-autoplay + - label: embla-carousel-solid + - label: embla-carousel-auto-height + - label: embla-carousel-class-names + - label: embla-carousel-docs **(Documentation)** + - label: embla-carousel-docs **(Generator)** + + - type: checkboxes + id: terms + attributes: + label: Before submitting + description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/davidjerleke/embla-carousel/blob/master/CONTRIBUTING.md). + options: + - label: I've made research efforts and searched the documentation + required: true + - label: I've searched for existing issues + required: true + - label: I agree to follow this project's Contributing Guidelines for bug reports + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..8f2c609f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/davidjerleke/embla-carousel/discussions/new?category=q-a + about: Ask questions and discuss with other community members + - name: Feature request + url: https://github.com/davidjerleke/embla-carousel/discussions/new?category=ideas + about: Feature requests should be opened as discussions diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 555d5026b..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: feature request -assignees: '' ---- - -### Feature request is related to - -- [ ] embla-carousel (core package) -- [ ] embla-carousel-react -- [ ] embla-carousel-vue -- [ ] embla-carousel-svelte -- [ ] embla-carousel-autoplay -- [ ] embla-carousel-auto-height -- [ ] embla-carousel-class-names -- [ ] embla-carousel-docs (documentation) -- [ ] embla-carousel-docs (generator) - -### Is your feature request related to an issue? - -- A clear and concise description of what the problem is. - -### Describe the solution you'd like - -- A clear and concise description of what you want to happen. - -### Describe alternatives you've considered - -- A clear and concise description of alternative solutions or features you've considered. - -### Additional context - -Add any other context or screenshots about the feature request here.