Issues templates

This commit is contained in:
Edward Firmo
2024-01-09 23:09:15 +01:00
parent 1fc0b22f44
commit 945732b51a
4 changed files with 195 additions and 0 deletions

135
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View File

@@ -0,0 +1,135 @@
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.
title: "`BUG` "
labels: [Bug]
body:
- type: markdown
attributes:
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.
> [!WARNING]
> Remember to 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.
- type: input
attributes:
label: TFT Version
description: Enter the version number of TFT.
placeholder: e.g., 4.1.4
validations:
required: false
- type: input
attributes:
label: ESPHome Version
description: Enter the version number of ESPHome.
placeholder: e.g., 4.1.4
validations:
required: false
- type: input
attributes:
label: Blueprint Version
description: Enter the version number of the Blueprint.
placeholder: e.g., 4.1.4
validations:
required: false
- type: markdown
attributes:
value: |
## Please provide details about the bug
- 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...
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.
placeholder: |
1. Go to '...'
2. Click on '...'
3. See error
validations:
required: true
- type: markdown
attributes:
value: |
## Please provide some additional info, when possible
- type: textarea
attributes:
label: Your panel's YAML
description: Please provide device'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
- type: textarea
attributes:
label: ESPHome logs
description: You can get this by clicking the **Logs** button related to your device on ESPHome Dashboard.
render: logs
validations:
required: false
- type: textarea
attributes:
label: Home Assistant logs
description: You can get this from **Settings** > **System** > **Logs** in your Home Assistant.
render: logs
validations:
required: false

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Troubleshooting TFT transfer
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: Getting Started with NSPanel HA Blueprint
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.

30
.github/ISSUE_TEMPLATE/enhancement.yml vendored Normal file
View File

@@ -0,0 +1,30 @@
name: Enhancement Request
description: Suggest an idea for this project
title: "`ENHANCEMENT` "
labels: [Enhancement]
body:
- type: markdown
attributes:
value: "Thank you for taking the time to suggest an enhancement!"
- type: input
attributes:
label: Enhancement Summary
description: A brief summary of the enhancement.
placeholder: e.g., Add support for XYZ feature...
validations:
required: true
- type: textarea
attributes:
label: Detailed Description
description: Please provide a detailed description of the enhancement. Include any specific use cases or functionality you envision.
placeholder: "Describe the enhancement in detail..."
validations:
required: true
- type: textarea
attributes:
label: Additional Context
description: "Provide any additional context or screenshots that might help us understand the enhancement better."
placeholder: "Add any other context or screenshots about the enhancement request here."

22
.github/ISSUE_TEMPLATE/question.yml vendored Normal file
View File

@@ -0,0 +1,22 @@
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."