|
| 1 | +# Copyright 2024 The MathWorks, Inc. |
| 2 | + |
| 3 | +name: "🐞 Bug Report" |
| 4 | +title: "[Enter short description of bug.]" |
| 5 | +description: "Report a bug." |
| 6 | +labels: [bug, needs-triage] |
| 7 | +body: |
| 8 | + - type: markdown |
| 9 | + attributes: |
| 10 | + value: | |
| 11 | + Before reporting a bug, see [Issues](https://github.com/mathworks/jupyter-matlab-proxy/issues) to check if an issue already exists for the bug you encountered. To request a feature or report a vulnerability, return to [Create an Issue](https://github.com/mathworks/jupyter-matlab-proxy/issues/new/choose). |
| 12 | +
|
| 13 | + - type: markdown |
| 14 | + attributes: |
| 15 | + value: | |
| 16 | + ## Provide details about the bug: |
| 17 | + * What is the problem? |
| 18 | + * What behavior were you expecting? |
| 19 | + * What happened instead? |
| 20 | + * Include full errors, uncaught exceptions, stack traces, and relevant logs. |
| 21 | + * Provide a sequence of steps to reproduce the issue. |
| 22 | + * Suggest a fix, if possible. |
| 23 | + * Any additional information that might be relevant. |
| 24 | + |
| 25 | + - type: textarea |
| 26 | + id: bug-summary |
| 27 | + attributes: |
| 28 | + label: Summary |
| 29 | + |
| 30 | + - type: dropdown |
| 31 | + id: browsers |
| 32 | + attributes: |
| 33 | + label: Browser(s) used |
| 34 | + multiple: true |
| 35 | + options: |
| 36 | + - Chrome |
| 37 | + - Firefox |
| 38 | + - Safari |
| 39 | + - Microsoft Edge |
| 40 | + |
| 41 | + - type: dropdown |
| 42 | + id: Feature-issue |
| 43 | + attributes: |
| 44 | + label: Issue found in |
| 45 | + multiple: true |
| 46 | + options: |
| 47 | + - MATLAB Kernel |
| 48 | + - MATLAB Desktop |
| 49 | + - Syntax Highlighting, Auto Indentation, Tab Completion |
| 50 | + - MAGIC Commands |
| 51 | + - Others |
| 52 | + |
| 53 | + - type: markdown |
| 54 | + attributes: |
| 55 | + value: | |
| 56 | + ## Run the `troubleshooting.py` script and paste the output below. |
| 57 | + |
| 58 | + ```bash |
| 59 | + $ python ./troubleshooting/troubleshooting.py |
| 60 | + ``` |
| 61 | + If you are collecting logs using the MWI_LOG_FILE environment variable, we recommend you provide the variable when executing the troubleshooting script: |
| 62 | + ```bash |
| 63 | + $ MWI_LOG_FILE="/tmp/log.file" python ./troubleshooting/troubleshooting.py |
| 64 | + ``` |
| 65 | + For more information about the `MWI_LOG_FILE` environment variable, see [Advanced-Usage.md](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/Advanced-Usage.md) |
| 66 | + For more information about the troubleshooting script, see [Troubleshooting](https://github.com/mathworks/jupyter-matlab-proxy/tree/main/troubleshooting) |
| 67 | + |
| 68 | +
|
| 69 | + - type: textarea |
| 70 | + id: troubleshooting-script-output |
| 71 | + attributes: |
| 72 | + label: Script output |
0 commit comments