diff --git a/.github/ISSUE_TEMPLATE/1.bug_report.yml b/.github/ISSUE_TEMPLATE/1.bug_report.yml new file mode 100644 index 00000000..a362a993 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1.bug_report.yml @@ -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.' diff --git a/.github/ISSUE_TEMPLATE/2.feature_request.yml b/.github/ISSUE_TEMPLATE/2.feature_request.yml new file mode 100644 index 00000000..9dc9018d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2.feature_request.yml @@ -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...' diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dd84ea78..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here.