From ce6e083010e785b2cd9c13311f14991a7a408f0b Mon Sep 17 00:00:00 2001 From: Simon Fischer Date: Mon, 18 Mar 2024 22:19:57 +0100 Subject: [PATCH 1/2] update issue / feature request template --- .github/ISSUE_TEMPLATE/BugReport.md | 68 +++++++++++++++++++++++---- .github/ISSUE_TEMPLATE/Enhancement.md | 40 +++++++++++++++- 2 files changed, 98 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BugReport.md b/.github/ISSUE_TEMPLATE/BugReport.md index 4f5cf01..b9484c9 100644 --- a/.github/ISSUE_TEMPLATE/BugReport.md +++ b/.github/ISSUE_TEMPLATE/BugReport.md @@ -7,30 +7,82 @@ assignees: 'DutchmanNL' --- **!!! Before you start !!!** -1. Verify if there is not already an issue requesting the same -2. Is this really a bug of current code, or an enhancement request ? +- [ ] I have verified that there is not already an issue with the same problem +- [ ] This is really a bug of current code, not an enhancement request (f.e. adding support for a new device type). There is a dedicated template for feature-requests. **Describe the bug** A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: -1. Go to '...' -2. Click on '...' -3. Scroll down to '....' -4. See error +1. Create a new device with given yaml. +2. ... (compile, flash, trigger some action on device / try to control state in iobroker, ...) +3. + +Minimal! Yaml config to reproduce. +Keep all that is required to copy-paste, compile, flash and reproduce the issue - but try to remove as much as possible that is not relevant to this issue! +Just an example, insert you own yaml!: +```yaml +esphome: + name: esp-01 + +esp8266: + board: esp01_1m + +# Enable logging +logger: + +# Enable Home Assistant API +api: + +ota: + password: "verysecretotapassword" + +wifi: + ssid: !secret wifi_ssid + password: !secret wifi_password + +light: + - platform: binary + name: "Fancy Light" + output: light_output + +output: + - id: light_output + platform: gpio + pin: + number: GPIO16 + mode: + output: true +``` **Expected behavior** A clear and concise description of what you expected to happen. -**Screenshots & Logfiles** -If applicable, add screenshots and logfiles to help explain your problem. +**Logs (as screenshot and in text-form)** + +ALL ioBroker logs of the esphome adapter (in a reasonable timeframe around when the issue happened). Not just the latest as this is often not helpful.: + +(insert screenshot here) +```txt +esphome.0 2024-03-18 04:20:31.141 info Try to connect to 1.2.3.4 +... +``` + +If applicable, other logs (like compile logs in dashboard): + +(insert screenshot here) +```txt +... +``` **Versions:** - Adapter version: + - ESPHome Dashboard version: - JS-Controller version: - Node version: - Operating system: + - Installation Method: installation script / Docker / ... **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/Enhancement.md b/.github/ISSUE_TEMPLATE/Enhancement.md index 1baca9f..4d27bcc 100644 --- a/.github/ISSUE_TEMPLATE/Enhancement.md +++ b/.github/ISSUE_TEMPLATE/Enhancement.md @@ -6,8 +6,9 @@ labels: 'enhancement' assignees: 'DutchmanNL' --- -**!!! Before you start !!!!** -Verify if there is not already an issue requesting the same Enhancement +**!!! Before you start !!!!** +- [ ] I have verified that there is not already an issue requesting the same Enhancement +- [ ] Is it about adding support for a new device-type? **Describe wanted Enhancement !** A clear description of the wanted functionality @@ -15,5 +16,40 @@ A clear description of the wanted functionality **Why should we put effort in it ?** Please add some additional information why this Enhancement should be integrated +**Example YAML** +If applicable, example yaml that demonstrates / can be used to test the new proposed functionality. +Just an example, insert you own yaml!: +```yaml +esphome: + name: test + friendly_name: test + +esp8266: + board: esp01_1m + +# Enable logging +logger: + +# Enable Home Assistant API +api: + +ota: + password: "verysecretotapassword" + +wifi: + ssid: !secret wifi_ssid + password: !secret wifi_password + +select: + - platform: template + name: "Template select" + optimistic: true + options: + - one + - two + - three + initial_option: two +``` + **Additional context** Add any other context about the problem here. From 92f71d5dd4525caead6e990776cf81dbc4ed583c Mon Sep 17 00:00:00 2001 From: Simon Fischer Date: Mon, 18 Mar 2024 22:22:59 +0100 Subject: [PATCH 2/2] clarify something --- .github/ISSUE_TEMPLATE/BugReport.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BugReport.md b/.github/ISSUE_TEMPLATE/BugReport.md index b9484c9..9b95033 100644 --- a/.github/ISSUE_TEMPLATE/BugReport.md +++ b/.github/ISSUE_TEMPLATE/BugReport.md @@ -61,7 +61,7 @@ A clear and concise description of what you expected to happen. **Logs (as screenshot and in text-form)** -ALL ioBroker logs of the esphome adapter (in a reasonable timeframe around when the issue happened). Not just the latest as this is often not helpful.: +ALL ioBroker logs of the esphome adapter (in a reasonable timeframe around when the issue happened). Not just the latest log-message as this is often not helpful.: (insert screenshot here) ```txt