Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ISSUE_TEMPLATE #20

Merged
merged 3 commits into from
Aug 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: 🐞 Bug report
description: Create a report to help us improve BigVectorBench
title: "[Bug]: "
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: |
When I do <X>, <Y> happens and I see the error message attached below:
```...```
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
placeholder: When I do <X>, <Z> should happen instead.
validations:
required: false
- type: textarea
attributes:
label: Steps/Code To Reproduce behavior
description: |
Follow this [guide](https://matthewrocklin.com/minimal-bug-reports) to craft a minimal bug report.
This helps us reproduce the issue you're having and resolve the issue more quickly.
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Environment details
description: |
Enter the Environment Details:
value: |
- Hardware/Softward conditions (OS, CPU, GPU, Memory):
- Method of installation (Docker, or from source):
- Configuration (Dataset, algorithm, etc.):
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
If applicable, add screenshots to help explain your problem.
Links? References? Anything that will give us more context about the issue you are encountering!
validations:
required: false
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: GitHub Community Support
url: https://github.com/orgs/community/discussions
about: Please ask and answer questions here.
- name: GitHub Security Bug Bounty
url: https://bounty.github.com/
about: Please report security vulnerabilities here.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Enhancement request
description: As a developer, I want to make an enhancement for BigVectorBench
title: "[Enhancement]: "
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to request/suggest an enhancement for BigVectorBench! Please fill the form in English!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue related to this already exists.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: What would you like to be added?
description: A concise description of what you're expecting/suggesting.
placeholder: |
I would like to suggest/request a feature that's like...
validations:
required: true
- type: textarea
attributes:
label: Why is this needed?
description: A concise description of the reason/motivation
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Screenshots? Anything that will give us more context about this!
validations:
required: false
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: 🚀 Feature request
description: Suggest an idea for BigVectorBench
title: "[FEATURE]: "
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to request a feature for BigVectorBench!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue related to this feature request already exists.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is.
placeholder: I wish I could use BigVectorBench to do [...]
validations:
required: false
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: false
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: Add any other context, code examples, or references to existing implementations about the feature request here.
validations:
required: false
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/general-question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: 🤔 General question
description: Ask a general question about BigVectorBench
title: "[QUESTION]: "
labels: [question]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue related to this already exists.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: What is your question?
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: Add any other context, code examples, or references about the question?
validations:
required: false
Loading