update bug-report.yml (#78)

su77ungr · May 17, 2023 · 662c557 · 662c557
1 parent f29182b
commit 662c557
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -13,8 +13,9 @@ body:
     id: env
     attributes:
       label: .env
-      description: Please share your exact .env file
+      description: Please share your exact .env file. *format it with ``` as in the example below.*
       placeholder: |
+        ```
         # Generic
         MODEL_N_CTX=1024
         TEXT_EMBEDDINGS_MODEL=sentence-transformers/all-MiniLM-L6-v2
@@ -36,6 +37,7 @@ body:
         N_RETRIEVE_DOCUMENTS=100 # How many documents to retrieve from the db
         N_FORWARD_DOCUMENTS=6 # How many documents to forward to the LLM, chosen among those retrieved
         N_GPU_LAYERS=4
+        ```
 
     validations:
       required: true
@@ -58,7 +60,7 @@ body:
     id: system-info-casalioy
     attributes:
       label: CASALIOY version
-      placeholder: can be either a release number (ex. `0.0.8`) or a commit id (ex `13cce0e`)
+      placeholder: A release number (ex. `0.0.8`) or a commit id (ex `13cce0e`)
     validations:
       required: true