h3n3/NSPanel_HA_Blueprint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Pointing questions to Discussions area

Browse Source
This commit is contained in:
Edward Firmo
2024-01-18 08:06:05 +01:00
parent ce049f5c8e
commit ea0839ee26
3 changed files with 36 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
.github/ISSUE_TEMPLATE/bug.yml vendored
View File

@@ -1,8 +1,6 @@
---
name: Bug Report
description: |
We aim to keep everything running smoothly.
Please fill out the form with details to help us identify and address the issue.
description: If something isn't working as expected, let us know here.
title: "`Bug` "
labels: [Bug]
body:
@@ -11,23 +9,25 @@ body:
value: |
Thanks for taking the time to fill out a bug report!
We wanna everything always working like a charm, so please let us know where our attention is needed.
We aim to keep everything working perfectly, so your detailed reports are crucial.
Report only one specific issue per submission. If you encounter another issue, create a new report for effective tracking and resolution.
The more detail you provide, the quicker we can help.
> [!WARNING]
> Remember to omit any private or sensitive information, as this bug report will be publicly visible.
> Omit any private or sensitive information, as this bug report will be publicly visible.
- type: markdown
attributes:
value: |
## Please provide the version numbers for TFT, ESPHome, and Blueprint
You can find these version numbers on the boot screen of your device.
The Blueprint version can also be found in the automation where the blueprint is set.
## Version Information
Provide version numbers for TFT, ESPHome, and Blueprint. These can be found on your device's boot screen and in the automation where the blueprint is set.
- type: input
attributes:
label: TFT Version
description: Enter the version number of TFT.
description: Enter the TFT version number.
placeholder: e.g., 4.1.4
validations:
required: false
@@ -35,7 +35,7 @@ body:
- type: input
attributes:
label: ESPHome Version
description: Enter the version number of ESPHome.
description: Enter the ESPHome version number.
placeholder: e.g., 4.1.4
validations:
required: false
@@ -43,7 +43,7 @@ body:
- type: input
attributes:
label: Blueprint Version
description: Enter the version number of the Blueprint.
description: Enter the Blueprint version number.
placeholder: e.g., 4.1.4
validations:
required: false
@@ -62,78 +62,45 @@ body:
- type: markdown
attributes:
value: |
## Please provide details about the bug
## Bug Details
- type: input
attributes:
label: What is the bug?
description: A clear and concise description of what the bug is.
placeholder: e.g., When I try this, I'm getting this result, while I was expecting that...
description: Describe the bug clearly and concisely.
placeholder: e.g., When I try this, I get this result, but I expected that...
validations:
required: true
- type: textarea
attributes:
label: Steps to Reproduce
description: Steps to reproduce the behavior. Please feel free to share pictures of your screen or anything relevant.
description: Detail the steps to reproduce the behavior. Include screenshots or other relevant information.
placeholder: |
1. Go to '...'
2. Click on '...'
3. See error
3. See error on '...'
validations:
required: true
- type: markdown
attributes:
value: |
## Please provide some additional info, when possible
## Additional Information (Optional)
- type: textarea
attributes:
label: Your panel's YAML
description: Please provide device's YAML configuration.
label: Your Panel's YAML
description: Provide your panel's YAML configuration.
render: yaml
placeholder: |
substitutions:
# Settings - Editable values
device_name: "YOUR_NSPANEL_NAME"
wifi_ssid: !secret wifi_ssid
wifi_password: !secret wifi_password
nextion_update_url: "http://homeassistant.local:8123/local/nspanel_us.tft"
# Add-on configuration (if needed)
## Add-on climate
heater_relay: "1" # Possible values: "1" or "2"
# Customization area
##### My customization - Start #####
##### My customization - End #####
# Core and optional configurations
packages:
remote_package:
url: https://github.com/Blackymas/NSPanel_HA_Blueprint
ref: main
files:
- nspanel_esphome.yaml # Core package
# Optional advanced and add-on configurations
# - advanced/esphome/nspanel_esphome_advanced.yaml
# - nspanel_esphome_addon_climate_cool.yaml
- nspanel_esphome_addon_climate_heat.yaml
# - nspanel_esphome_addon_climate_dual.yaml
refresh: 300s
esp32:
framework:
type: esp-idf
validations:
required: false
# Example YAML configuration
# ...
- type: textarea
attributes:
label: ESPHome logs
description: You can get this by clicking the **Logs** button related to your device on ESPHome Dashboard.
description: Access these logs via the **Logs** button for your device on the ESPHome Dashboard.
render: logs
validations:
required: false
@@ -141,7 +108,7 @@ body:
- type: textarea
attributes:
label: Home Assistant logs
description: You can get this from **Settings** > **System** > [**Logs**](https://my.home-assistant.io/redirect/logs/) in your Home Assistant.
description: Access these logs from **Settings** > **System** > [**Logs**](https://my.home-assistant.io/redirect/logs/) in Home Assistant.
render: logs
validations:
required: false

20
.github/ISSUE_TEMPLATE/config.yml vendored
View File

@@ -1,16 +1,20 @@
---
blank_issues_enabled: false
contact_links:
- name: Discussions area
- name: Questions & General Discussions
url: https://github.com/Blackymas/NSPanel_HA_Blueprint/discussions
about: This is your go-to space for community conversations, questions, idea sharing, and collaboration around our project.
- name: Troubleshooting TFT Transfer
about: Join our Discussions for community chats, questions, idea sharing, and collaboration. Use Issues for reporting bugs or requesting enhancements.
- name: Troubleshooting TFT Transfer Issues
url: https://github.com/Blackymas/NSPanel_HA_Blueprint/blob/main/docs/tft_upload.md
about: Try this guide first if you are having issues to transfer a TFT file.
- name: Compiling Errors Guide
about: Having trouble transferring a TFT file? Our guide might have the solution.
- name: Resolve Compiling Errors
url: https://github.com/Blackymas/NSPanel_HA_Blueprint/blob/main/docs/error_compiling.md
about: Experiencing Compile Errors? Check This Guide!
- name: Getting Started with NSPanel HA Blueprint
about: Check this guide if you're experiencing compile errors.
- name: Getting Started Guide
url: https://github.com/Blackymas/NSPanel_HA_Blueprint/blob/main/docs/install.md
about: This is the starting poing for installing a new NSPanel HA Blueprint.
about: New to NSPanel HA Blueprint? Start here for installation and setup instructions.
...

24
.github/ISSUE_TEMPLATE/question.yml vendored
View File

@@ -1,24 +0,0 @@
---
name: Question
description: Ask a question about this project
title: "`Question` "
labels: [Question]
body:
- type: markdown
attributes:
value: "We're here to help! Ask your question below."
- type: input
attributes:
label: Question
description: What do you want to ask?
placeholder: e.g., How do I configure XYZ?
validations:
required: true
- type: textarea
attributes:
label: Additional Details
description: Provide any additional details or context for your question.
placeholder: "Add any more details about your question here."
...