-
-
Notifications
You must be signed in to change notification settings - Fork 275
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add bug report and feature request GitHub Form Template (#532)
- Loading branch information
1 parent
b442a3c
commit b6f1217
Showing
4 changed files
with
100 additions
and
58 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,67 @@ | ||
name: Bug Report | ||
description: Create a bug report for Orama | ||
labels: ['template: bug'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
This template is for Orama bugs. | ||
Before opening a new issue, check existing [issues](https://github.com/oramasearch/orama/issues) and upvote if applicable. | ||
- type: textarea | ||
attributes: | ||
label: Describe the bug | ||
description: A clear and concise description of the bug. | ||
placeholder: 'When I do X, Y happens instead of Z.' | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: To Reproduce | ||
description: Steps to reproduce the behavior. | ||
placeholder: | | ||
1. Initialize Orama | ||
2. Insert X data | ||
3. Search for Y | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Expected behavior | ||
description: What you expected to happen. | ||
placeholder: 'I expected A but got B.' | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Environment Info | ||
description: Details about your runtime environment. | ||
render: bash | ||
placeholder: | | ||
OS: MacOS 12.1 | ||
Node: 18.17.1 | ||
Orama: 2.1.3 | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
attributes: | ||
label: Affected areas | ||
multiple: true | ||
options: | ||
- 'Initialization' | ||
- 'Data Insertion' | ||
- 'Search' | ||
- 'Environment/OS' | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional context | ||
description: Extra information to help investigate. | ||
placeholder: 'Happens only on Linux.' |
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,33 @@ | ||
name: Feature Request | ||
description: Propose a new feature for Orama | ||
labels: ['template: feature'] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Problem Description | ||
description: What's the problem or limitation you're facing? | ||
placeholder: "It's challenging to..." | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Proposed Solution | ||
description: How do you envision the solution? | ||
placeholder: 'Orama could implement...' | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Alternatives | ||
description: Any other solutions or features you've considered? | ||
placeholder: 'Another approach could be...' | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional Context | ||
description: Any extra information or screenshots to help understand the feature request. | ||
placeholder: 'For example, in a scenario where...' |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.