Skip to content

Commit

Permalink
ci: added issue template (#32)
Browse files Browse the repository at this point in the history
  • Loading branch information
vtrbo authored Oct 21, 2023
1 parent 1d04301 commit 16b6dcd
Show file tree
Hide file tree
Showing 3 changed files with 115 additions and 0 deletions.
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: 🐞 Bug report
title: '[BUG] - YOUR_ISSUE_TITLE_HERE_REPLACE_ME'
description: Report an issue with utils
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
placeholder: Bug description
validations:
required: false
- type: input
id: reproduction
attributes:
label: Reproduction
description: Please provide a link via or a link to a repo that can reproduce the problem you ran into. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required.
placeholder: Reproduction
validations:
required: false
- type: textarea
id: system-info
attributes:
label: System Info
description: Output of `npx envinfo --system --npmPackages '{vtrbo/utils*}' --binaries --browsers`
render: Shell
placeholder: System, Binaries, Browsers
validations:
required: false
- type: dropdown
id: package-manager
attributes:
label: Used Package Manager
description: Select the used package manager
options:
- npm
- yarn
- pnpm
validations:
required: true
- type: checkboxes
id: checkboxes
attributes:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
# - label: Read the [docs](https://ikun-ui.netlify.app/).
# required: true
- label: Check that there isn't [already an issue](https://github.com/vtrbo/utils/issues) that reports the same bug to avoid creating a duplicate.
required: true
- label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
required: true
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: 👻 New feature proposal
title: '[Feature Request] - YOUR_FEATURE_TITLE_HERE_REPLACE_ME'
description: Propose a new feature to be added to utils.
labels: [feature request]
body:
- type: markdown
attributes:
value: |
Thanks for your interest in the project and taking the time to fill out this feature report! This issue form is for requesting features only! For example, requesting a new function, behavior ... etc
- type: textarea
id: feature-description
attributes:
label: Clear and concise description of the problem
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: false
- type: textarea
id: suggested-solution
attributes:
label: Suggested solution
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. ....
validations:
required: false
- type: textarea
validations:
required: false
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 ↓
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/others.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Others

description: Create an issue for utils

body:
- type: textarea
id: description
attributes:
label: Description
description: Clear and concise description of the issue. Thanks!
placeholder: There are some thing I want to ...
validations:
required: true

0 comments on commit 16b6dcd

Please sign in to comment.