From 60a3da8c2f729daddae9e86298a847a77990b224 Mon Sep 17 00:00:00 2001 From: Sir GoodEnough Date: Sun, 8 Oct 2023 21:40:04 -0500 Subject: [PATCH] Update issue handling --- .github/ISSUE_TEMPLATE/bug_report.md | 59 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 9 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 ++++++++ README.md | 9 ++++ 4 files changed, 96 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..c4b01d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,59 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG] " +labels: bug +assignees: '' + +--- + +**Ground Rules** +Before you report a 'Bug', you need to make sure you have read the accompanying Descriptions on the templates and the READ.ME for the GIT Repo completely and followed all the settings required there. +This is important as if these instructions are not followed, you will likely have a bad day and be forced to contact me for help. Not that I don't want to help, but personal interaction takes me a while to respond and is generally non-productive. + +Another good thing to do before you ask for help is try testing what you have in the Developer Tools Template Tab in Home Assistant. There you can adjust this and that until you figure out the answer to your question yourself. [![Open your Home Assistant instance and show your template developer tools.](https://my.home-assistant.io/badges/developer_template.svg)](https://my.home-assistant.io/redirect/developer_template/) + +Issues are not a place to ask questions, see the Discord links below for that. This is for broken things. If you are not sure, PLEASE go to Discord and ask the question first. + +If you have a general question, I prefer them to be asked on Discord. Ping me in the channel, I don't often respond to DM's... @sirgoodenough + +I also monitor the Blueprint Exchange post related to each Blueprint and will respond there. + +There are 3 places on Discord that I monitor, in preference order: + +My personal Discord Blueprints Channel: https://discord.gg/SKsAgCHvUm +DrZzs Home Assistant channel: https://discord.gg/pGzB8P5W4n +Home Assistant Template Channel: https://discord.gg/home-assistant + +Do if you think you found a bug where the text points you wrong, or something is just broken, continue here. If you have a Feature Request, see the other Issue Template... + +**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 + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**What version of the template has the issue?** + +**What was the version of Home Assistant Core?** +[![Open your Home Assistant instance and show health information about your system.](https://my.home-assistant.io/badges/system_health.svg)](https://my.home-assistant.io/redirect/system_health/) + +**What type of installation are you running?** +[![Open your Home Assistant instance and show health information about your system.](https://my.home-assistant.io/badges/system_health.svg)](https://my.home-assistant.io/redirect/system_health/) + +**YAML snippets INCLUDING the Script or Automation the template is being used in.** +(use 3 backticks before and after your code to format it properly) +See here for example: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..258ca4d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,9 @@ + +blank_issues_enabled: false +contact_links: + - name: My Discord Server + url: https://discord.gg/SKsAgCHvUm + about: Please reach out to @sirgoodenough in one of the channels for more info. No DM's. + - name: My Website + url: https://www.WhatAreWeFixing.Today/ + about: Links to all the ways to interact with me, Including YouTube, FacebBook, & Follow me on Twitter... diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..9f44900 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FR] " +labels: Feature Request +assignees: '' + +--- +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/README.md b/README.md index cdd89be..33536b1 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,15 @@ Install this in HACS or download the `availability_template.jinja` from this rep You *may* need to enable 'experimental features' mode. To do this find the HACS section of the Home Assistant Integration page. Click on the '>' arrow to bring you to the custom integration page. Then click on configure, and select 'enable experimental features' check box. click submit, then float out and restart the HA server to make sure it takes. When you come back HACS will look slightly different, but the Templates section is now visible and you will be able to select it. At some point in time HACS will update and the new interface and options will be the only available interface. +#### Other help + +Before you report a 'Bug', you need to make sure you have read the accompanying Descriptions on the templates and this README and have followed all the settings required here. +This is important because if these instructions are not followed, you will likely have a bad day and be forced to contact me for help. Not that I don't want to help, but personal interaction takes me a while to respond and is generally non-productive. + +Another good thing to do before you ask for help is try testing what you have in the Developer Tools Template Tab in Home Assistant. There you can adjust this and that until you figure out the answer to your question yourself. [![Open your Home Assistant instance and show your template developer tools.](https://my.home-assistant.io/badges/developer_template.svg)](https://my.home-assistant.io/redirect/developer_template/) + +********************* + # Availability Test ## `avail([entity1, entity2, /])`