From 97e16d83628ed19c010a616bd5fd607bc160eb63 Mon Sep 17 00:00:00 2001 From: HJD Date: Sun, 28 Apr 2024 12:09:08 -0500 Subject: [PATCH] Housekeeping. --- .github/ISSUE_TEMPLATE/bug_report.md | 45 ----------- .github/ISSUE_TEMPLATE/feature-request.yml | 29 +++++++ .github/ISSUE_TEMPLATE/feature_request.md | 22 ------ .github/ISSUE_TEMPLATE/support-request.yml | 89 ++++++++++++++++++++++ .github/workflows/issue-validate.yml | 18 ----- README.md | 13 +++- 6 files changed, 130 insertions(+), 86 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/support-request.yml delete mode 100644 .github/workflows/issue-validate.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 2aa7109..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Support Request -about: Report a bug or request help. Please read the documentation first before creating a support request. -title: '' -assignees: '' - ---- - - - - -**Describe The Problem:** - - -**To Reproduce:** - - -**Logs:** - - -``` -Show the Homebridge logs here. -Remove any sensitive information. -``` - -**Homebridge Configuration:** - -```json -Show the relevant portion of your homebridge config.json here, if needed. -Remove any sensitive information. -``` - -**Screenshots:** - - -**Environment:** - -* **Homebridge Version:** -* **Node Version:** -* **Homebridge-ratgdo Plugin Version**: -* **Apple Device and iOS / macOS / iPadOS / tvOS Version:** -* **Operating System and OS Version:** - - - diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..7adf66f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,29 @@ +name: Feature Request +description: Suggest an idea for an enhancement to HBR. Please read the HBR documentation first, including the feature options section, to verify what you're looking for isn't already implemented. +labels: enhancement +body: + - type: markdown + attributes: + value: | + ### Before opening a feature request, please ensure you have read the [documentation](https://github.com/hjdhjd/homebridge-ratgdo#documentation), especially the [feature option](https://github.com/hjdhjd/homebridge-ratgdo/blob/main/docs/FeatureOptions.md) page to see if the feature you're looking for doesn't already exist. + - type: textarea + id: feature-request + attributes: + label: Describe the feature request + description: Please describe the feature you are requesting. If the feature request relates to a specific problem you are encountering, please describe the use case. + validations: + required: true + - type: textarea + id: proposed-solution + attributes: + label: Describe the proposed solution + description: Please describe the proposed solution to the problem or use case described above. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you have considered to the enhancement + description: Please describe alternative approaches you've explored or considered to address the requested feature. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 500344c..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature Request -about: Suggest an idea for an enhancement. -title: '' -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe:** - - -**Describe the solution you'd like:** - - -**Describe alternatives you've considered:** - - -**Additional context:** - - - diff --git a/.github/ISSUE_TEMPLATE/support-request.yml b/.github/ISSUE_TEMPLATE/support-request.yml new file mode 100644 index 0000000..f8fae9e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support-request.yml @@ -0,0 +1,89 @@ +name: Support Request +description: Report a bug or request help. Please read the HBR documentation before creating a support request. +body: + - type: markdown + attributes: + value: | + ### Before opening a support request, please ensure you have read the [documentation](https://github.com/hjdhjd/homebridge-ratgdo#documentation). Questions and topics already addressed in the documentation, or in prior issue reports, will be closed without a response. + + - type: input + id: hbrversion + attributes: + label: Homebridge Ratgdo + description: Which version of Homebridge Ratgdo (HBR) are you running on? + placeholder: e.g. v2.1.0 + validations: + required: true + + - type: input + id: homebridgeos + attributes: + label: Homebridge Platform and OS + description: What hardware and operating system are you running Homebridge on? + placeholder: e.g. macOS Sonoma + validations: + required: true + + - type: input + id: homebridge + attributes: + label: Homebridge Version + description: Which version of Homebridge are you running on? + placeholder: e.g. v1.7.0 + validations: + required: true + + - type: input + id: node + attributes: + label: Node Version + description: Which version of Node are you running on? + placeholder: e.g. v18.1.0 + validations: + required: true + + - type: input + id: ratgdo + attributes: + label: Ratgdo ESPHome Firmware Version + description: Which version of the Ratgdo ESPHome firmware is your Ratgdo running on? + placeholder: e.g. v2024.3.2 + validations: + required: true + + - type: textarea + id: what-happened + attributes: + label: Describe the problem + description: Please describe the issue you're encountering, and ensure you include steps to reproduce. + validations: + required: true + + - type: textarea + id: config + attributes: + label: Homebridge HBR JSON configuration + description: Please copy and paste your Homebridge HBR JSON configuration. This will be automatically formatted into code, so no need for backticks. + placeholder: Paste your HBR configuration from Homebridge (gear icon in the Homebridge webUI next to HBR, then select JSON config). Copy and paste it here. + render: json + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant Homebridge HBR log output. This will be automatically formatted into code, so no need for backticks. + placeholder: Please paste the relevant log entries here. + render: shell + validations: + required: true + + - type: checkboxes + id: acknowledgment + attributes: + label: Acknowledgment that you are only running non-beta firmware releases from Apple, ESPHome, or Ratgdo + description: By submitting this issue, you are acknowledging that you are only using the official Ratgdo ESPHome firmware releases and that you are **not** running beta firmwares (or operating systems) from Apple, ESPHome, or Ratgdo. **All issues relating to beta firmwares or operating systems will be closed without comment.** + options: + - label: I acknowledge that I am not running any beta firmwares or operating systems from Apple, ESPHome, or Ratgdo. + required: true diff --git a/.github/workflows/issue-validate.yml b/.github/workflows/issue-validate.yml deleted file mode 100644 index 6c2676c..0000000 --- a/.github/workflows/issue-validate.yml +++ /dev/null @@ -1,18 +0,0 @@ -# Close issues that don't conform to the issue templates. -# -name: Close Non-Conforming Issues - -on: - issues: - types: [opened] - -jobs: - autoclose: - runs-on: ubuntu-latest - steps: - - name: Autoclose issues that don't follow the issue templates. - uses: roots/issue-closer@v1.1 - with: - issue-close-message: "@${issue.user.login} - this issue is being automatically closed because it does not follow either the feature request or bug report issue template. The issue templates have been designed to help in the troubleshooting (or feature request) process. Please use them and populate it as completely as possible to streamline troubleshooting or feature request discussions." - issue-pattern: "Describe alternatives you've considered|Homebridge-ratgdo Plugin Version" - repo-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/README.md b/README.md index f70e1f9..bc4ce4f 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,8 @@ In the interest of the community seeking a solution outside of myQ, I've develop * Automation switch and dimmer support, allowing you to set the garage door to any position. * A rich webUI for configuration. -## Getting Started +## Installation +### Getting Started To get started with `homebridge-ratgdo`: * Install `homebridge-ratgdo` using the Homebridge webUI. Make sure you make `homebridge-ratgdo` a child bridge for the best performance. @@ -43,6 +44,16 @@ To get started with `homebridge-ratgdo`: * Fully open and close the garage door one time. ESPHome Ratgdo will use this to determine how long it takes to open and close your garage door to enable precise control of the position of the garage door opener. * That's it. Ensure `homebridge-ratgdo` is running and it will autodiscover your Ratgdo devices and make them available in HomeKit. +## Documentation +* Getting Started + * [Installation](#installation): installing this plugin, including system requirements. + * [Plugin Configuration](#getting-started): how to quickly get up and running. + * [Changelog](https://github.com/hjdhjd/homebridge-ratgdo/blob/main/docs/Changelog.md): changes and release history of this plugin, starting with v3.0. + +* Additional Topics + * [Feature Options](https://github.com/hjdhjd/homebridge-ratgdo/blob/main/docs/FeatureOptions.md): granular options to allow you to set the camera quality individually, show or hide specific cameras, controllers, and more. + * [MQTT](https://github.com/hjdhjd/homebridge-ratgdo/blob/main/docs/MQTT.md): how to configure MQTT support. + ## Plugin Development Dashboard This is mostly of interest to the true developer nerds amongst us.