-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add bug report & feature request template (#24)
* feat(github): add bug report * feat(github): add issue template config * feat(github): add feature request * chore(.github): add missing CLI wording
- Loading branch information
Showing
3 changed files
with
139 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| name: 'Bug report' | ||
| title: "[BUG] - YOUR_ISSUE_TITLE_HERE_REPLACE_ME" | ||
| description: Create a report to help us improve | ||
| labels: [bug] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for reporting an issue :pray:. | ||
| This issue tracker is for reporting bugs found in [NextUI CLI github repository](https://github.com/nextui-org/nextui-cli/) | ||
| 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 CLI's [Discussion's tab](https://github.com/nextui-org/nextui-cli/discussions) | ||
| - NextUI's [Discord channel](https://discord.gg/9b6yyZKmH4) | ||
| Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already: | ||
| - NextUI CLI's [Issue's tab](https://github.com/nextui-org/nextui-cli/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) | ||
| - NextUI CLI's [closed issues tab](https://github.com/nextui-org/nextui-cli/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed) | ||
| - NextUI CLI's [Discussions tab](https://github.com/nextui-org/nextui-cli/discussions) | ||
| The more information you fill in, the better the community can help you. | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: NextUI CLI Version | ||
| description: | | ||
| Please provide the version of NextUI CLI you are using. | ||
| You can find the version number in the package.json file. | ||
| placeholder: ex. 0.1.4 | ||
| validations: | ||
| required: true | ||
| - 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: 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. Run '...' | ||
| 2. View the output '....' | ||
| 3. 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 operating system are you using? | ||
| placeholder: | | ||
| - OS: [e.g. macOS, Windows, Linux] | ||
| validations: | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| blank_issues_enabled: true | ||
| contact_links: | ||
| - name: 🤔 Long question or ideas? | ||
| url: https://github.com/nextui-org/nextui-cli/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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| name: Feature request | ||
| title: "[Feature Request] YOUR_FEATURE_TITLE_HERE_REPLACE_ME" | ||
| labels: [feature request] | ||
| description: | | ||
| 💡 Suggest an idea for the `NextUI CLI` project | ||
| Examples | ||
| - propose a new command | ||
| - improve an exiting features | ||
| - ....etc | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| This issue form is for requesting features only! For example, requesting a new command, behavior ... etc | ||
| If you want to report a bug, please use the [bug report form](https://github.com/nextui-org/nextui-cli/issues/new?assignees=&labels=&template=bug_report.yml). | ||
| - 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. Run the command '...' | ||
| 2. Select '....' | ||
| 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 ↓ |