Skip to content

Commit

Permalink
Add bug report and feature request GitHub Form Template (#532)
Browse files Browse the repository at this point in the history
  • Loading branch information
ludovicobesana committed Nov 1, 2023
1 parent b442a3c commit b6f1217
Show file tree
Hide file tree
Showing 4 changed files with 100 additions and 58 deletions.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/1.bug_report.yml
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.'
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/2.feature_request.yml
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...'
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit b6f1217

Please sign in to comment.