add PR template (#64)
Browse files* 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
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!-- 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. -->
|
| 2 |
+
|
| 3 |
+
<!-- add additional description, question etc. related to the new dataset -->
|
| 4 |
+
|
| 5 |
+
|
| 6 |
+
## Checklist
|
| 7 |
+
<!-- Please do not delete this -->
|
| 8 |
+
|
| 9 |
+
- [ ] Run tests locally to make sure nothing is broken using `make test`.
|
| 10 |
+
- [ ] Run the results files checker `make pre-push`.
|
| 11 |
+
|
| 12 |
+
### Adding a model checklist
|
| 13 |
+
<!--
|
| 14 |
+
When adding a model to the model registry
|
| 15 |
+
see also https://github.com/embeddings-benchmark/mteb/blob/main/docs/reproducible_workflow.md
|
| 16 |
+
-->
|
| 17 |
+
Ref # <!-- Add mteb PR number here -->
|
| 18 |
+
|
| 19 |
+
- 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)
|