-
Notifications
You must be signed in to change notification settings - Fork 655
Update issue and pr templates #2782
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
71f070b
Update issue templates
Samoed e37c1ec
Update bug_report.md
Samoed 20ffc6c
test yaml template
Samoed bc9d38c
add templates
Samoed f6c2065
update templates
Samoed fd6c519
add emojis
Samoed ca6d3cb
fix typo
Samoed 780cf62
Apply suggestions from code review
Samoed 50f6291
update issue titles
Samoed 32a15ae
update PR template
Samoed d3c020e
remove PR templates
Samoed File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| name: 🗃New dataset | ||
|
Samoed marked this conversation as resolved.
Outdated
|
||
| description: Create a request for a new dataset to be added to MTEB | ||
| title: "dataset: " | ||
|
Samoed marked this conversation as resolved.
Outdated
|
||
| labels: ["new dataset"] | ||
| body: | ||
| - type: textarea | ||
|
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. | ||
|
Samoed marked this conversation as resolved.
Outdated
|
||
| validations: | ||
| required: true | ||
| - type: textarea | ||
|
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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| name: 🤖New model | ||
|
Samoed marked this conversation as resolved.
Outdated
|
||
| description: Create a request for a new model to be added to MTEB | ||
| title: "model: " | ||
|
Samoed marked this conversation as resolved.
Outdated
|
||
| labels: ["new model"] | ||
| body: | ||
| - type: textarea | ||
|
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 | ||
|
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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
|
|
||
|
|
|
Samoed marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.