Skip to content

chore: add an issue and feature template #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 90 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
name: 🐛 Bug Report
description: Report a bug to help us improve
labels: [bug, triage]
body:
- type: markdown
attributes:
value: |
## 🙏 Thanks for taking the time to report this issue!
### Please complete the information below to help us fix the problem quickly.

- type: textarea
id: description
attributes:
label: 🔍 Describe the bug
description: A clear and concise description of what the bug is
placeholder: When I try to use the package or API, it breaks when I...
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: 🔄 Steps to reproduce
description: How can we recreate this issue? Be specific!
placeholder: |
1. Import '...'
2. Initialize or make a request '...'
3. See error
validations:
required: true

- type: textarea
id: expected
attributes:
label: ✅ Expected behavior
description: What did you expect to happen?
placeholder: The package or API should handle or make a request correctly...
validations:
required: true

- type: dropdown
id: os
attributes:
label: 💻 Operating System
multiple: true
options:
- Windows
- macOS
- Linux
- Other (please specify in Additional Info)
validations:
required: true

- type: input
id: version
attributes:
label: 📊 Node and package Version
description: What Node and package version are you using?
placeholder: e.g Node v22.16.0 and @upstash/ratelimit v2.0.5
validations:
required: true

- type: textarea
id: screenshots
attributes:
label: 📷 Screenshots
description: If applicable, add screenshots to help explain your problem
placeholder: You can paste images directly here!
validations:
required: false

- type: textarea
id: additional
attributes:
label: 📝 Additional context
description: Add any other information about the problem here
placeholder: Related issues, etc.
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: ✨ Before submitting
description: Please confirm the following
options:
- label: 🔍 I've searched for existing issues and this hasn't been reported before
required: true
- label: ℹ️ I've included all the information needed to reproduce the issue
required: true
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: ✨ Feature Request
description: Suggest an idea or enhancement for this project
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
## 🌟 Thanks for taking the time to share your ideas!
### We appreciate your contribution to making our project better.

- type: dropdown
id: feature_type
attributes:
label: 🎯 Type of feature
description: What kind of feature are you proposing?
options:
- New functionality
- Enhancement to existing feature
- Developer experience improvement
- Performance improvement
- Other (please describe below)
validations:
required: true

- type: textarea
id: problem
attributes:
label: 🤔 Is your feature request related to a problem?
description: Please describe what problem you're trying to solve
placeholder: I'm always frustrated when [...]
validations:
required: false

- type: textarea
id: solution
attributes:
label: 💡 Desired solution
description: Describe what you want to happen
placeholder: It would be great if the package or API could...
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: 🔄 Alternatives considered
description: Describe any alternative solutions or features you've considered
placeholder: I thought about implementing it by...
validations:
required: false

- type: textarea
id: examples
attributes:
label: 🔍 Examples from other projects
description: Are there other projects that have something similar to what you're requesting?
placeholder: This feature exists in [project link] and works by...
validations:
required: false

- type: textarea
id: context
attributes:
label: 📝 Additional context
description: Add any other context, mockups, or screenshots about the feature request here
placeholder: You can paste images directly here!
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: ✅ Before submitting
options:
- label: 🔍 I've searched for existing feature requests and this hasn't been suggested before
required: true
- label: 🙋 I'm willing to help implement or test this feature if needed
required: false