Readme and Doc update (#459)

* big update

* update

* typos

* add: sentencetransformer

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -6,7 +6,7 @@ body:
     attributes:
       label: System Info
       description: | 
-        Please share your system info with us (`infinity_emb --help` if installed locally).
+        Please share your system info with us (`infinity_emb v2 --help` if installed locally).
         The full command line used that causes issues: 
         OS version: (linux/win/macos)
         Model being used (BAAI/..)
@@ -23,16 +23,17 @@ body:
       label: Information
       description: 'The problem arises when using:'
       options:
-        - label: "Docker"
-        - label: "The CLI directly via pip"
+        - label: "Docker + cli"
+        - label: "pip + cli"
+        - label: "pip + usage of Python interface"
 
   - type: checkboxes
     id: information-tasks
     attributes:
       label: Tasks
       description: "The thing I am working on is:"
       options:
-        - label: "An officially supported command"
+        - label: "An officially supported CLI command"
         - label: "My own modifications"
 
   - type: textarea
@@ -53,12 +54,9 @@ body:
           1.
           2.
           3.
+
+        Expected behavior:
+          ..
+        
           
 
-  - type: textarea
-    id: expected-behavior
-    validations:
-      required: true
-    attributes:
-      label: Expected behavior
-      description: "A clear and concise description of what you would expect to happen."

.github/ISSUE_TEMPLATE/new-model-addition.yml

@@ -1,5 +1,5 @@
 name: "\U0001F31F Model support"
-description: Submit a proposal/request to implement a new model
+description: Submit a proposal/request to fix a currently not working model
 labels: [ "New model" ]
 
 body:
@@ -15,18 +15,13 @@ body:
   - type: checkboxes
     id: information-tasks
     attributes:
-      label: Open source status
+      label: Open source status & huggingface transformers.
       description: |
-          Please note that if the model implementation isn't available in `transformers`, the model can't be loaded.
+          Please note that if the model implementation isn't available in huggingface libraries (`transformers`), the model can't be loaded.
       options:
         - label: "The model implementation is available on transformers"
         - label: "The model weights are available on huggingface-hub"
-        - label: "I verified that the model is currently not running in the lastest version `pip install infinity_emb[all] --upgrade`"
+        - label: "I verified that the model is currently not running in the latest version `pip install infinity_emb[all] --upgrade`"
+        - label: "I made the authors of the model aware that I want to use it with infinity_emb & check if they are aware of the issue."
+
 
-  - type: textarea
-    id: additional-info
-    attributes:
-      label: Provide useful links for the implementation
-      description: |
-        Please provide information regarding the implementation, the weights, and the authors.
-        Please mention the authors by @gh-username if you're aware of their usernames.

.github/pull_request_template.md

@@ -1,24 +1,22 @@
-## Description
-Please provide a clear and concise description of the changes in this PR.
+<!--
+Congratulations! You've made it this far! Thanks for submitting a PR to Infinity!
+
+## License & CLA
+By submitting this PR, I confirm that my contribution is made under the terms of the [MIT license](https://github.com/michaelfeil/infinity/blob/main/LICENSE).
+-->
 
 ## Related Issue
-If applicable, link the issue this PR addresses.
 
-## Types of Change
-- [ ] Bug fix
-- [ ] New feature
-- [ ] Documentation update
+<!--
+If you are sure that a related issue should be automatically closed, use the syntax to close issue 123.
+
+closes #123
+-->
 
 ## Checklist
 - [ ] I have read the [CONTRIBUTING](https://github.com/michaelfeil/infinity/tree/main?tab=readme-ov-file#contribute-and-develop) guidelines.
-- [ ] My code follows the code style of this project.
 - [ ] I have added tests to cover my changes.
-- [ ] All new and existing tests passed.
-- [ ] My changes generate no new warnings.
-- [ ] I have updated the documentation accordingly.
+- [ ] I have updated the documentation (docs folder) accordingly.
 
 ## Additional Notes
 Add any other context about the PR here.
-
-## License
-By submitting this PR, I confirm that my contribution is made under the terms of the [MIT license](https://github.com/michaelfeil/infinity/blob/main/LICENSE).