Skip to content

Commit

Permalink
Merge pull request #671 from smultar/master
Browse files Browse the repository at this point in the history
Improve bug report and feature request templates
  • Loading branch information
davidjerleke authored Jan 14, 2024
2 parents 03f3d0e + f6ef842 commit 710312d
Show file tree
Hide file tree
Showing 6 changed files with 199 additions and 81 deletions.
24 changes: 24 additions & 0 deletions .github/DISCUSSION_TEMPLATE/help.yml
Original file line number Diff line number Diff line change
@@ -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
60 changes: 60 additions & 0 deletions .github/DISCUSSION_TEMPLATE/ideas.yml
Original file line number Diff line number Diff line change
@@ -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
46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

107 changes: 107 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 710312d

Please sign in to comment.