Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update issue / feature request template #204

Merged
merged 2 commits into from
Mar 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 60 additions & 8 deletions .github/ISSUE_TEMPLATE/BugReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 log-message 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: <adapter-version>
- ESPHome Dashboard version: <dashboard-version>
- JS-Controller version: <js-controller-version> <!-- determine this with `iobroker -v` on the console -->
- Node version: <node-version> <!-- determine this with `node -v` on the console -->
- Operating system: <os-name>
- Installation Method: installation script / Docker / ...

**Additional context**
Add any other context about the problem here.
40 changes: 38 additions & 2 deletions .github/ISSUE_TEMPLATE/Enhancement.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,50 @@ 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

**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.
Loading