Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 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
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Comment thread
Samoed marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: 🐞 Bug Report
description: Create a bug report to help us improve
title: "bug: "
body:
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of the bug, as well as what you expected to happen when encountering it.
validations:
required: true
- type: textarea
attributes:
label: To reproduce
description: Describe how to reproduce your bug. Please provide detailed steps, code snippets, reproduction repos etc.
validations:
required: true
- type: textarea
attributes:
label: Additional information
description: Add any other information related to the bug here, screenshots if applicable.
- type: dropdown
id: contribute
attributes:
label: Are you interested to contribute a fix for this bug?
description: If this is a confirmed bug, the maintainers are happy to support with guidance and review.
options:
- "No"
- "Yes"
validations:
required: true
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: ✨Enhancement
description: Create a request for a new feature
labels: ["enhancement"]
body:
- type: textarea
attributes:
label: Description of the feature
description: Please provide a clear and concise description of the feature you would like to see added.
validations:
required: true

15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/new_dataset.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: 🗃New dataset
Comment thread
Samoed marked this conversation as resolved.
Outdated
description: Create a request for a new dataset to be added to MTEB
title: "dataset: "
Comment thread
Samoed marked this conversation as resolved.
Outdated
labels: ["new dataset"]
body:
- type: textarea
Comment thread
Samoed marked this conversation as resolved.
Outdated
attributes:
label: dataset link on Hugging dataset
description: Please provide a link to the dataset on Hugging Face.
Comment thread
Samoed marked this conversation as resolved.
Outdated
validations:
required: true
- type: textarea
Comment thread
Samoed marked this conversation as resolved.
Outdated
attributes:
label: Arxiv link
description: If the dataset is based on a paper, please provide a link to the paper on Arxiv or another academic repository.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/new_model.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: 🤖New model
Comment thread
Samoed marked this conversation as resolved.
Outdated
description: Create a request for a new model to be added to MTEB
title: "model: "
Comment thread
Samoed marked this conversation as resolved.
Outdated
labels: ["new model"]
body:
- type: textarea
Comment thread
Samoed marked this conversation as resolved.
Outdated
attributes:
label: Model link on Hugging Face
description: Please provide a link to the model on Hugging Face. If the model is closed-source, please provide a link to the model provider or documentation.
validations:
required: true
- type: textarea
Comment thread
Samoed marked this conversation as resolved.
Outdated
attributes:
label: Arxiv link
description: If the model is based on a paper, please provide a link to the paper on Arxiv or another academic repository.
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!-- add `fix:` to the title of this PR -->
Fix <issue number>

<!-- add a description of the bug and how this PR fixes it -->
# Description
6 changes: 6 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/new_dataset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<!-- add `dataset:` to the title of this PR -->
Fix <issue number>

- [ ] I did not add a dataset, or if I did, I added the [dataset checklist](https://github.com/embeddings-benchmark/mteb/blob/main/docs/adding_a_dataset.md#submit-a-pr) to the PR and completed it.

# Description
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/new_model.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!-- add `model:` to the title of this PR -->
Fix <issue number>

- [ ] I did not add a model, or if I did, I added the [model checklist](https://github.com/embeddings-benchmark/mteb/blob/main/docs/adding_a_model.md#submitting-your-model-as-a-pr) to the PR and completed it.

<!-- add a description of the bug and how this PR fixes it -->
# Description


10 changes: 4 additions & 6 deletions .github/pull_request_template.md
Comment thread
Samoed marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
Please go to the `Preview` tab and select the appropriate sub-template:


### Checklist
<!-- please do not delete this checklist -->

- [ ] I did not add a dataset, or if I did, I added the [dataset checklist](https://github.com/embeddings-benchmark/mteb/blob/main/docs/adding_a_dataset.md#submit-a-pr) to the PR and completed it.
- [ ] I did not add a model, or if I did, I added the [model checklist](https://github.com/embeddings-benchmark/mteb/blob/main/docs/adding_a_model.md#submitting-your-model-as-a-pr) to the PR and completed it.
* [Fixing a bug or enchatment](?expand=1&template=bug_fix.md)
* [Adding new dataset](?expand=1&template=new_dataset.md)
* [Adding new model](?expand=1&template=new_model.md)