Skip to content

Commit

Permalink
docs: add feature request issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
sammccord committed Sep 17, 2024
1 parent ca74855 commit 305864e
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform

- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://docs.boost.xyz/boost-protocol). If you are looking for support, you might want to check [this section](#i-have-a-question)).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/rabbitholegg/boost-protocolissues?q=label%3Abug).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/rabbitholegg/boost-protocol/issues?q=label%3Abug).
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
Expand Down
18 changes: 10 additions & 8 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
name: Bug Report
name: 🐛 Bug Report
description: File a bug/issue
title: 'bug: <title>'
title: "fix: <title>"
labels:
- "bug"
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! The more info you provide, the more we can help you. If you are a [Sponsor](https://github.com/sponsors/wagmi-dev?metadata_campaign=gh_issue), your issues are prioritized.
Thanks for taking the time to fill out this bug report! The more info you provide, the more we can help you.
- type: checkboxes
attributes:
Expand All @@ -18,7 +20,7 @@ body:
- type: input
attributes:
label: Package Version
description: What version of questdk are you using?
description: What version are you using?
placeholder: 0.1.0
validations:
required: true
Expand All @@ -28,7 +30,7 @@ body:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
required: true

- type: textarea
attributes:
Expand All @@ -42,15 +44,15 @@ body:
label: Steps To Reproduce
description: Steps or code snippets to reproduce the behavior.
validations:
required: false
required: true

- type: input
attributes:
label: Link to Minimal Reproducible Example (StackBlitz, CodeSandbox, GitHub repo etc.)
description: |
Please provide a link via [rabbithole.gg](https://rabbithole.gg/) or a link to a minimal repository that can reproduce the problem you ran into.
Please provide a link to a minimal repository that can reproduce the problem you ran into.
This makes investigating issues and helping you out significantly easier! For most issues, you will likely get asked to provide one so why not add one now :)
placeholder: https://rabbithole.gg/
placeholder: https://github.com/YOUR/REPO
validations:
required: false

Expand Down
7 changes: 0 additions & 7 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1 @@
blank_issues_enabled: false
contact_links:
- name: Ask Question
url: https://github.com/rabbitholegg/questdk/discussions/new?category=q-a
about: Ask questions and discuss with other community members
- name: Request Feature
url: https://github.com/rabbitholegg/questdk/discussions/new?category=ideas
about: Requests features or brainstorm ideas for new functionality
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: 🛠️ Feature Request
description: Suggest an idea to help us improve
title: "feat: "
labels:
- "feature"

body:
- type: markdown
attributes:
value: >
**Thanks :heart: for taking the time to fill out this feature request report!** We kindly ask that you search to
see if an issue [already exists](https://github.com/rabbitholegg/boost-protocol/issues?q=is%3Aissue+sort%3Acreated-desc+) for
your feature.
We are also happy to accept contributions from our users. For more details see
[here](https://github.com/rabbitholegg/boost-protocol/blob/main/.github/CONTRIBUTING.md).
- type: textarea
attributes:
label: Description
description: |
A clear and concise description of the feature you're interested in.
value: |
<!--- Describe your feature here --->
validations:
required: true

- type: textarea
attributes:
label: Suggested Solution
description: >
Describe the solution you'd like. A clear and concise description of what you want to happen. If you have
considered alternatives, please describe them.
value: |
<!--- Describe your solution here --->
validations:
required: false

0 comments on commit 305864e

Please sign in to comment.