diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000000..c724dca707 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,30 @@ +name: 🐞 Bug Report +description: Create a bug report to help us improve +type: 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 diff --git a/.github/ISSUE_TEMPLATE/enhancement.yaml b/.github/ISSUE_TEMPLATE/enhancement.yaml new file mode 100644 index 0000000000..0aa03a2fd0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yaml @@ -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 + diff --git a/.github/ISSUE_TEMPLATE/new_dataset.yaml b/.github/ISSUE_TEMPLATE/new_dataset.yaml new file mode 100644 index 0000000000..3e152ccb8b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_dataset.yaml @@ -0,0 +1,15 @@ +name: 🗃 New dataset +description: Create a request for a new dataset to be added to MTEB +title: "Add dataset: {dataset_name}" +labels: ["new dataset"] +body: + - type: input + attributes: + label: dataset link on Hugging dataset + description: Please provide a link to the dataset, ideally to Hugging Face. + validations: + required: true + - type: input + 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. diff --git a/.github/ISSUE_TEMPLATE/new_model.yaml b/.github/ISSUE_TEMPLATE/new_model.yaml new file mode 100644 index 0000000000..b7d96af261 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_model.yaml @@ -0,0 +1,15 @@ +name: 🤖 New model +description: Create a request for a new model to be added to MTEB +title: "Add model: {model_id}" +labels: ["new model"] +body: + - type: input + 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: input + 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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 96e5ca69e1..b3559046df 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,4 @@ +If you add a model or a dataset, please add the corresponding checklist: - -### 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. +* [dataset checklist](https://github.com/embeddings-benchmark/mteb/blob/main/docs/adding_a_dataset.md#submit-a-pr) +* [model checklist](https://github.com/embeddings-benchmark/mteb/blob/main/docs/adding_a_model.md#submitting-your-model-as-a-pr)