update ISSUE_TEMPLATE folder files

This commit is contained in:
Clifford Fajardo 2022-02-28 21:04:24 +00:00 committed by GitHub
parent 5c2966d59d
commit b74ce1cc51
6 changed files with 146 additions and 70 deletions

88
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,88 @@
name: 'Bug report'
description: Create a report to help us improve
body:
- type: markdown
attributes:
value: |
Thank you for reporting an issue :pray:.
This issue tracker is for reporting bugs found in `NextUI` (https://github.com/nextui-org/nextui/).
If you have a question about how to achieve something and are struggling, please post a question
inside of either of the following places:
- NextUI's Discussion's tab: https://github.com/nextui-org/nextui/discussions
- NextUI's Discord channel: https://foambubble.github.io/join-discord/g
Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
- NextUI's Issue's tab: https://github.com/nextui-org/nextui/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc
- NextUI's closed issues tab: https://github.com/nextui-org/nextui/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed
- NextUI's Discussions tab: https://github.com/nextui-org/nextui/discussions
The more information you fill in, the better the community can help you.
- type: textarea
id: description
attributes:
label: Describe the bug
description: Provide a clear and concise description of the challenge you are running into.
validations:
required: true
- type: input
id: link
attributes:
label: Your Example Website or App
description: |
Which website or app were you using when the bug happened?
Note:
- Your bug will may get fixed much faster if we can run your code and it doesn't have dependencies other than the `@nextui-org/react` npm package.
- To create a shareable code example you can use Stackblitz (https://stackblitz.com/). Please no localhost URLs.
- Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
placeholder: |
e.g. https://stackblitz.com/edit/...... OR Github Repo
validations:
required: false
- type: textarea
id: steps
attributes:
label: Steps to Reproduce the Bug or Issue
description: Describe the steps we have to take to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
description: Provide a clear and concise description of what you expected to happen.
placeholder: |
As a user, I expected ___ behavior but i am seeing ___
validations:
required: true
- type: textarea
id: screenshots_or_videos
attributes:
label: Screenshots or Videos
description: |
If applicable, add screenshots or a video to help explain your problem.
For more information on the supported file image/file types and the file size limits, please refer
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
placeholder: |
You can drag your video or image files inside of this editor ↓
- type: input
id: os
attributes:
label: Operating System Version
description: What opearting system are you using?
placeholder: |
- OS: [e.g. macOS, Windows, Linux]
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional context
description: |
Add any other context about the problem here.

11
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: 🤔 Long question or ideas?
url: https://github.com/nextui-org/nextui/discussions
about: Ask long-form questions and discuss ideas.
- name: 💬 Discord Community Chat
url: https://discord.gg/9b6yyZKmH4
about: Ask quick questions or simply chat on the `NextUI` community Discord server.
- name: 💬 New Updates (Twitter)
url: https://twitter.com/getnextui
about: Link to our twitter account if you want to follow us and stay up to date with NextUI news

View File

@ -0,0 +1,47 @@
name: Feature request
description: |
💡 Suggest an idea for the `NextUI` project
Examples
- propose a new component
- improve an exiting component
- ....etc
body:
- type: markdown
attributes:
value: |
This issue form is for requesting features only! For example, requesting a new component, behavior ... etc
If you want to report a bug, please use the [bug report](https://github.com/nextui-org/nextui/issues/new?assignees=&labels=&template=bug_report.yml) form.
- type: textarea
validations:
required: true
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
- type: textarea
validations:
required: true
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
placeholder: |
As a user, I expected ___ behavior but ___ ...
Ideal Steps I would like to see:
1. Go to '...'
2. Click on '....'
3. ....
- type: textarea
validations:
required: true
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
attributes:
label: Screenshots or Videos
description: |
If applicable, add screenshots or a video to help explain your problem.
For more information on the supported file image/file types and the file size limits, please refer
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
placeholder: |
You can drag your video or image files inside of this editor ↓

View File

@ -1,17 +0,0 @@
---
name: Improve and existing component
about: Suggest to add a new Prop, functionality and else
title: ''
labels: ''
assignees: ''
---
**Is your iteration request related to a problem?**
Do you need more flexibility in your theme? Please add a clear and concise description of what the current problem is.
**Describe the solution you'd like**
A clear and concise description of what you want to achieve.
**Additional context**
Add any other context or screenshots about the feature request here.

View File

@ -1,21 +0,0 @@
---
name: Propose a new component
about: Do you need a new component?
title: ''
labels: ''
assignees: ''
---
**Is your component proposal related to a problem? Please describe.**
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 have.
**Describe alternatives you've considered**
Have you considered iterating an existing component?
If so, please add a clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

View File

@ -1,32 +0,0 @@
---
name: Report a bug / issue
about: Report a bug / issue to help us improve NextUI
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
A clear and concise description.
**Steps to reproduce**
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behaviour**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Environment / Context**
- Desktop or Mobile?
- Operating System: [e.g. iOS]
- Browser and version [e.g. chrome 22]
- Device: [e.g. iPhone6]
**Additional info**
Add any other context about the problem here.