diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..e897823095 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,22 @@ + + + + + +## Checklist + + +- [ ] Run tests locally to make sure nothing is broken using `make test`. +- [ ] Run the results files checker `make pre-push`. + +### Adding a model checklist + + + - [ ] I have added model implementation to `mteb/models/` [directory](https://github.com/embeddings-benchmark/mteb/tree/main/mteb/models). Instruction to add a model can be found [here](https://github.com/embeddings-benchmark/mteb/blob/main/docs/reproducible_workflow.md) + - [ ] I have ensured that my model can be loaded using + - [ ] `mteb.get_model(model_name, revision)` and + - [ ] `mteb.get_model_meta(model_name, revision)` + - [ ] I have tested the implementation works on a representative set of tasks. \ No newline at end of file