From bce24b8c471dfb93cc17615bcffbc83df9ceb153 Mon Sep 17 00:00:00 2001 From: selemondev Date: Wed, 28 May 2025 10:19:32 -0600 Subject: [PATCH] chore: add issue template --- .github/ISSUE_TEMPLATE/bug_report.yaml | 90 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 78 ++++++++++++++++++ 2 files changed, 168 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..6908fc9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..5966eb9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -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 \ No newline at end of file