Browse Source

github: update issue templates [no ci] (#18410)

* github: update issue templates [no ci]

* Apply suggestions from code review

Co-authored-by: Sigbjørn Skjæret <sigbjorn.skjaeret@scala.com>

---------

Co-authored-by: Sigbjørn Skjæret <sigbjorn.skjaeret@scala.com>
Johannes Gäßler 1 month ago
parent
commit
e59efe6a78

+ 2 - 1
.github/ISSUE_TEMPLATE/010-bug-compilation.yml

@@ -8,7 +8,8 @@ body:
       value: >
       value: >
         Thanks for taking the time to fill out this bug report!
         Thanks for taking the time to fill out this bug report!
         This issue template is intended for bug reports where the compilation of llama.cpp fails.
         This issue template is intended for bug reports where the compilation of llama.cpp fails.
-        Before opening an issue, please confirm that the compilation still fails with `-DGGML_CCACHE=OFF`.
+        Before opening an issue, please confirm that the compilation still fails
+        after recreating the CMake build directory and with `-DGGML_CCACHE=OFF`.
         If the compilation succeeds with ccache disabled you should be able to permanently fix the issue
         If the compilation succeeds with ccache disabled you should be able to permanently fix the issue
         by clearing `~/.cache/ccache` (on Linux).
         by clearing `~/.cache/ccache` (on Linux).
   - type: textarea
   - type: textarea

+ 13 - 2
.github/ISSUE_TEMPLATE/011-bug-results.yml

@@ -98,7 +98,18 @@ body:
       label: Relevant log output
       label: Relevant log output
       description: >
       description: >
           Please copy and paste any relevant log output, including the command that you entered and any generated text.
           Please copy and paste any relevant log output, including the command that you entered and any generated text.
-          This will be automatically formatted into code, so no need for backticks.
-      render: shell
+          For very long logs (thousands of lines), preferably upload them as files instead.
+          On Linux you can redirect console output into a file by appending ` > llama.log 2>&1` to your command.
+      value: |
+        <details>
+        <summary>Logs</summary>
+        <!-- Copy-pasted short logs go into the "console" area here -->
+
+        ```console
+
+        ```
+        </details>
+
+        <!-- Long logs that you upload as files go here, outside the "console" area -->
     validations:
     validations:
       required: true
       required: true

+ 13 - 2
.github/ISSUE_TEMPLATE/019-bug-misc.yml

@@ -85,8 +85,19 @@ body:
       label: Relevant log output
       label: Relevant log output
       description: >
       description: >
           If applicable, please copy and paste any relevant log output, including any generated text.
           If applicable, please copy and paste any relevant log output, including any generated text.
-          This will be automatically formatted into code, so no need for backticks.
           If you are encountering problems specifically with the `llama_params_fit` module, always upload `--verbose` logs as well.
           If you are encountering problems specifically with the `llama_params_fit` module, always upload `--verbose` logs as well.
-      render: shell
+          For very long logs (thousands of lines), please upload them as files instead.
+          On Linux you can redirect console output into a file by appending ` > llama.log 2>&1` to your command.
+      value: |
+        <details>
+        <summary>Logs</summary>
+        <!-- Copy-pasted short logs go into the "console" area here -->
+
+        ```console
+
+        ```
+        </details>
+
+        <!-- Long logs that you upload as files go here, outside the "console" area -->
     validations:
     validations:
       required: false
       required: false