|
| 1 | +name: 🐞 Bug Report |
| 2 | +description: File a bug report. |
| 3 | + |
| 4 | +labels: ["bug"] |
| 5 | +assignees: |
| 6 | + - donavanbecker |
| 7 | + - SwitchBot |
| 8 | + - SwitchBot-Wonderlabs |
| 9 | + - Minsheng |
| 10 | + - Devin-Wonderlabs |
| 11 | + - chenliuyun |
| 12 | + |
| 13 | +body: |
| 14 | + - type: markdown |
| 15 | + attributes: |
| 16 | + value: | |
| 17 | + Hi. Thanks for taking the time to fill out this bug report! |
| 18 | +
|
| 19 | + Before we start, be sure you are aware of the following points: |
| 20 | + - Review any Troubleshooting and FAQ pages in the Wiki or Readme to ensure your issue isn't already solved by those steps. |
| 21 | + - Avoid duplicating any existing issues which already track or resolved your problem. |
| 22 | + - Aim to find a descriptive and precise title for your bug report. |
| 23 | + - Please add the `beta` label, if your issue is releated to a current beta release. |
| 24 | + - type: textarea |
| 25 | + id: analysis |
| 26 | + attributes: |
| 27 | + label: Analysis |
| 28 | + description: Please provide a concise description of the bug or issue you encounter. |
| 29 | + placeholder: A clear and concise description of what the bug is. |
| 30 | + validations: |
| 31 | + required: true |
| 32 | + |
| 33 | + - type: textarea |
| 34 | + id: expected-behavior |
| 35 | + attributes: |
| 36 | + label: Expected Behavior |
| 37 | + description: Please provide a clear and concise description of what you expected to happen. |
| 38 | + placeholder: A clear and concise description of what you expected to happen. |
| 39 | + validations: |
| 40 | + required: true |
| 41 | + |
| 42 | + - type: textarea |
| 43 | + id: reproduction |
| 44 | + attributes: |
| 45 | + label: Steps To Reproduce |
| 46 | + description: Please provide a description of how to reproduce the issue. |
| 47 | + placeholder: | |
| 48 | + A description of how to reproduce the bug. |
| 49 | + 1. In this setup or under those conditions ... |
| 50 | + 2. Run ... |
| 51 | + 3. Encounter error ... |
| 52 | + validations: |
| 53 | + required: true |
| 54 | + |
| 55 | + - type: textarea |
| 56 | + id: logs |
| 57 | + attributes: |
| 58 | + label: Logs |
| 59 | + description: | |
| 60 | + Please provide relevant log output. |
| 61 | + Be sure to **remove any sennsitive information** (passwords, tokens, etc.). |
| 62 | + If you have lengthy log message, please use the file upload functionality in the `Additional Context` section to supply log files. |
| 63 | + placeholder: Please paste logging output. Refer to the GitHub Wiki on how to enable `DEBUG` output. |
| 64 | + render: markdown |
| 65 | + validations: |
| 66 | + required: true |
| 67 | + |
| 68 | + - type: textarea |
| 69 | + id: config |
| 70 | + attributes: |
| 71 | + label: Configuration |
| 72 | + description: | |
| 73 | + Please provide, if applicable, the content of your configuration files (e.g. `config.json`). |
| 74 | + Be sure to **remove any sennsitive information** (passwords, tokens, etc.). |
| 75 | + If you have lengthy configuration, please use the file upload functionality in the `Additional Context` section to supply config files. |
| 76 | + placeholder: Please paste configuration ... |
| 77 | + render: json |
| 78 | + validations: |
| 79 | + required: true |
| 80 | + |
| 81 | + - type: textarea |
| 82 | + id: environment |
| 83 | + attributes: |
| 84 | + label: Environment |
| 85 | + description: | |
| 86 | + Describe your Environment when running Node/Python/Etc. |
| 87 | + It should include Operating System version, runtime version and the version of the software itself. |
| 88 | +
|
| 89 | + The environment description might look like the following: |
| 90 | + - **OS**: Ubuntu 20.04 |
| 91 | + - **Node**: 18.13.0 (outpout of `node -v`) |
| 92 | + - **npm**: 8.1.0 (output of `npm -v`) |
| 93 | + value: | |
| 94 | + - OS: |
| 95 | + - Software: |
| 96 | + - Node: |
| 97 | + - npm: |
| 98 | + validations: |
| 99 | + required: true |
| 100 | + |
| 101 | + - type: textarea |
| 102 | + id: additional-context |
| 103 | + attributes: |
| 104 | + label: Additional Context |
| 105 | + description: | |
| 106 | + Please provide any additional context that might be relevant for your bug report. |
| 107 | +
|
| 108 | + It might include screenshots, configuration (files) or log output. |
| 109 | + placeholder: Any additional context that might be relevant for your bug report. |
0 commit comments