Skip to content

Commit

Permalink
Update issue templates (#557)
Browse files Browse the repository at this point in the history
  • Loading branch information
basnijholt authored Apr 8, 2023
1 parent c0c3631 commit 39e9d0e
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 17 deletions.
68 changes: 57 additions & 11 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,63 @@
---
name: 'Bug Report'
about: 'Report a bug in adaptive-lighting.'
labels: kind/bug, need/triage
name: Bug Report
about: Report a bug in adaptive-lighting.
title: ''
labels: kind/bug, kind/feature, need/triage
assignees: ''

---

#### Version information:
# Home Assistant Adaptive Lighting Issue Template

## Bug Reports

If you need help with using or configuring Adaptive Lighting, please [open a Q&A discussion thread here](https://github.com/basnijholt/adaptive-lighting/discussions/new?category=q-a) instead.

### Before submitting a bug report, please follow these troubleshooting steps:

Please confirm that you have completed the following steps:

- [ ] I have updated to the [latest Adaptive Lighting version](https://github.com/basnijholt/adaptive-lighting/releases) available in [HACS](https://hacs.xyz/).
- [ ] I have reviewed the [Troubleshooting Section](https://github.com/basnijholt/adaptive-lighting#troubleshooting) in the [README](https://github.com/basnijholt/adaptive-lighting#readme).
- [ ] (If using Zigbee2MQTT) I have read the [Zigbee2MQTT troubleshooting guide](https://github.com/basnijholt/adaptive-lighting#zigbee2mqtt) in the [README](https://github.com/basnijholt/adaptive-lighting#readme).
- [ ] I have checked the [V2 Roadmap](https://github.com/basnijholt/adaptive-lighting/discussions/291) and [open issues](https://github.com/basnijholt/adaptive-lighting/issues) to ensure my issue isn't a duplicate.


### Required information for bug reports:

Please include the following information in your issue.

*Issues missing this information may not be addressed.*

1. **Debug logs** captured while the issue occurred. [See here for instructions on enabling debug logging](https://github.com/basnijholt/adaptive-lighting#troubleshooting):

```
```

2. [Your Adaptive Lighting configuration](https://github.com/basnijholt/adaptive-lighting#gear-configuration):

```
```

3. (If using Zigbee2MQTT), provide your configuration files (**remove all personal information before posting**):
- `devices.yaml`
- `groups.yaml`
- `configuration.yaml` ⚠️; **Warning** _**REMOVE ALL of the PERSONAL INFORMATION BELOW before posting**_ ⚠️;
- mqtt: `server`:
- mqtt: `user`:
- mqtt: `password`:
- advanced: `pan_id`:
- advanced: `network_key`:
- anything in `log_syslog` if you use this
- Brand and model number of problematic light(s)
```
```

4. Describe the bug and how to reproduce it:


#### Description:
<!-- This is where you get to tell us what went wrong. When doing so, please make sure to include *all* relevant information.

Please try to include:
* What you were doing when you experienced the bug.
* Any error messages you saw, *where* you saw them, and what you believe may have caused them (if you have any ideas).
* When possible, steps to reliably produce the bug.
-->
5. Steps to reproduce the behavior:
7 changes: 5 additions & 2 deletions .github/ISSUE_TEMPLATE/doc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
name: 'Documentation Issue'
about: 'Report missing, erroneous docs, broken links or propose new docs'
name: Documentation Issue
about: Report missing, erroneous docs, broken links or propose new docs
title: ''
labels: kind/docs_issue, need/triage
assignees: ''

---

#### Location
Expand Down
7 changes: 5 additions & 2 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
name: 'Enhancement'
about: 'Suggest an improvement to an existing feature.'
name: Enhancement
about: Suggest an improvement to an existing feature.
title: ''
labels: kind/enhancement, need/triage
assignees: ''

---
7 changes: 5 additions & 2 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
name: 'Feature'
about: 'Suggest a new feature'
name: Feature
about: Suggest a new feature
title: ''
labels: kind/feature, need/triage
assignees: ''

---

0 comments on commit 39e9d0e

Please sign in to comment.