From ce8ba30149c86eb3807cf641d039503f9a9502c2 Mon Sep 17 00:00:00 2001
From: Roman Solomatin <samoed.roman@gmail.com>
Date: Sun, 8 Dec 2024 14:03:48 +0500
Subject: [PATCH] add PR template (#64)

* add PR template

* Update .github/pull_request_template.md

Co-authored-by: Isaac Chung <chungisaac1217@gmail.com>

* update

---------

Co-authored-by: Isaac Chung <chungisaac1217@gmail.com>
---
 .github/pull_request_template.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000000..68386fd05a
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,19 @@
+<!-- If you are submitting a dataset or a model for the model registry, please use the corresponding checklists below. Otherwise, feel free to remove them. -->
+
+<!-- add additional description, question etc. related to the new dataset -->
+
+
+## Checklist
+<!-- Please do not delete this -->
+
+- [ ] Run tests locally to make sure nothing is broken using `make test`. 
+- [ ] Run the results files checker `make pre-push`.
+
+### Adding a model checklist
+<!-- 
+When adding a model to the model registry
+see also https://github.com/embeddings-benchmark/mteb/blob/main/docs/reproducible_workflow.md
+-->
+Ref # <!-- Add mteb PR number here -->
+
+- 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)