From d185677a28e7b0ebebd0938f54cfcec91c36abee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20=C4=8Cerm=C3=A1k?= Date: Wed, 11 Nov 2026 14:26:57 +0100 Subject: [PATCH] Point bug reports and pull requests to the app repositories Each app now lives in its own app-* repository, and the app folders here are overwritten on every app release. Issues and pull requests for an app belong in its repository. Replace the bug report form with one contact link per app on the new issue page, each leading to the issue tracker of the app repository. The only apps left without a repository are deprecated, so the form has no remaining use. Point the README bug link and the task form to the new issue page, and put the task form notice on single lines so GitHub doesn't render each line break as a hard break. Add a pull request template that sends app changes to the app repositories and keeps this repository for repository-wide changes. --- .github/ISSUE_TEMPLATE/bug_report.yml | 141 ------------------- .github/ISSUE_TEMPLATE/config.yml | 68 ++++++++- .github/ISSUE_TEMPLATE/task.yml | 14 +- .github/PULL_REQUEST_TEMPLATE.md | 20 +++ .github/workflows/restrict-task-creation.yml | 7 +- README.md | 5 +- 6 files changed, 99 insertions(+), 156 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 8670b505c..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,141 +0,0 @@ ---- -# yamllint disable rule:line-length -name: Bug Report Form -description: Report an issue related to one of the official apps (formerly known as add-ons). -body: - - type: markdown - attributes: - value: | - This issue form is for reporting bugs with **supported** setups only! - - If you have a feature or enhancement request, please use our [Feature Requests][fr]. - - [fr]: https://github.com/orgs/home-assistant/discussions - - - type: textarea - validations: - required: true - attributes: - label: Describe the issue you are experiencing - description: Provide a clear and concise description of what the bug is. - - - type: markdown - attributes: - value: | - ## Environment - - - type: dropdown - validations: - required: true - attributes: - label: What type of installation are you running? - description: > - If you don't know, can be found in [Settings -> System -> Repairs -> System Information](https://my.home-assistant.io/redirect/system_health/). - It is listed as the `Installation Type` value. - options: - - Home Assistant OS - - Home Assistant Supervised - - - type: dropdown - validations: - required: true - attributes: - label: Which operating system are you running on? - options: - - Home Assistant Operating System - - Debian - - Other (e.g., Raspbian/Raspberry Pi OS/Fedora) - - - type: dropdown - validations: - required: true - attributes: - label: Which app are you reporting an issue with? - options: - - CEC Scanner - - File editor - - deCONZ - - Dnsmasq - - Duck DNS - - Git pull - - Google Assistant SDK - - Let's Encrypt - - MariaDB - - Matter Server - - Mosquitto broker - - NGINX Home Assistant SSL proxy - - OpenThread Border Router - - Piper - - RPC Shutdown - - Samba share - - Silicon Labs Flasher - - Silicon Labs Multiprotocol - - Terminal & SSH - - VLC - - Whisper - - Z-Wave JS - - - type: input - validations: - required: true - attributes: - label: What is the version of the app? - description: Can be found in [Settings > Apps](https://my.home-assistant.io/redirect/supervisor/) -> the app - - - type: markdown - attributes: - value: | - # Details - - - type: textarea - validations: - required: true - attributes: - label: Steps to reproduce the issue - description: | - Please tell us exactly how to reproduce your issue. - Provide clear and concise step by step instructions and add code snippets if needed. - value: | - 1. - 2. - 3. - ... - - - type: textarea - validations: - required: true - attributes: - label: System Health information - description: > - System Health information can be found in the top right menu in [Settings -> System -> Repairs](https://my.home-assistant.io/redirect/repairs/). - Click the copy button at the bottom of the pop-up and paste it here. - - [![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/) - - - type: textarea - attributes: - label: Anything in the Supervisor logs that might be useful for us? - description: > - Supervisor Logs can be found in [Settings -> System -> Logs](https://my.home-assistant.io/redirect/logs/) - then choose `Supervisor` in the top right. - - [![Open your Home Assistant instance and show your Supervisor system logs.](https://my.home-assistant.io/badges/supervisor_logs.svg)](https://my.home-assistant.io/redirect/supervisor_logs/) - render: txt - - - type: textarea - attributes: - label: Anything in the app logs that might be useful for us? - description: > - App Logs can be found in [Settings > System > Logs](https://my.home-assistant.io/redirect/logs/) - then choose the app in the top right. - - [![Open your Home Assistant instance and show your Home Assistant logs.](https://my.home-assistant.io/badges/logs.svg)](https://my.home-assistant.io/redirect/logs/) - render: txt - - - type: textarea - attributes: - label: Additional information - description: > - If you have any additional information for us, use the field below. - Please note, you can attach screenshots or screen recordings here, by - dragging and dropping files in the field below. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index dd64fe56f..126a9a0bf 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,12 +2,78 @@ # yamllint disable rule:line-length blank_issues_enabled: false contact_links: + - name: Report a bug with the CEC Scanner app + url: https://github.com/home-assistant/app-cec-scan/issues + about: Each app has its own repository. Please report issues with the CEC Scanner app there. + - name: Report a bug with the deCONZ app + url: https://github.com/home-assistant/app-deconz/issues + about: Each app has its own repository. Please report issues with the deCONZ app there. + - name: Report a bug with the Dnsmasq app + url: https://github.com/home-assistant/app-dnsmasq/issues + about: Each app has its own repository. Please report issues with the Dnsmasq app there. + - name: Report a bug with the Duck DNS app + url: https://github.com/home-assistant/app-duckdns/issues + about: Each app has its own repository. Please report issues with the Duck DNS app there. + - name: Report a bug with the File editor app + url: https://github.com/home-assistant/app-configurator/issues + about: Each app has its own repository. Please report issues with the File editor app there. + - name: Report a bug with the Git pull app + url: https://github.com/home-assistant/app-git-pull/issues + about: Each app has its own repository. Please report issues with the Git pull app there. + - name: Report a bug with the Let's Encrypt app + url: https://github.com/home-assistant/app-letsencrypt/issues + about: Each app has its own repository. Please report issues with the Let's Encrypt app there. + - name: Report a bug with the MariaDB app + url: https://github.com/home-assistant/app-mariadb/issues + about: Each app has its own repository. Please report issues with the MariaDB app there. + - name: Report a bug with the Matter Server app + url: https://github.com/home-assistant/app-matter-server/issues + about: Each app has its own repository. Please report issues with the Matter Server app there. + - name: Report a bug with the Mosquitto broker app + url: https://github.com/home-assistant/app-mosquitto/issues + about: Each app has its own repository. Please report issues with the Mosquitto broker app there. + - name: Report a bug with the NGINX Home Assistant SSL proxy app + url: https://github.com/home-assistant/app-nginx-proxy/issues + about: Each app has its own repository. Please report issues with the NGINX Home Assistant SSL proxy app there. + - name: Report a bug with the OpenThread Border Router app + url: https://github.com/home-assistant/app-openthread-border-router/issues + about: Each app has its own repository. Please report issues with the OpenThread Border Router app there. + - name: Report a bug with the openWakeWord app + url: https://github.com/home-assistant/app-openwakeword/issues + about: Each app has its own repository. Please report issues with the openWakeWord app there. + - name: Report a bug with the Piper app + url: https://github.com/home-assistant/app-piper/issues + about: Each app has its own repository. Please report issues with the Piper app there. + - name: Report a bug with the RPC Shutdown app + url: https://github.com/home-assistant/app-rpc-shutdown/issues + about: Each app has its own repository. Please report issues with the RPC Shutdown app there. + - name: Report a bug with the Samba share app + url: https://github.com/home-assistant/app-samba/issues + about: Each app has its own repository. Please report issues with the Samba share app there. + - name: Report a bug with the Silicon Labs Flasher app + url: https://github.com/home-assistant/app-silabs-flasher/issues + about: Each app has its own repository. Please report issues with the Silicon Labs Flasher app there. + - name: Report a bug with the Speech-to-Phrase app + url: https://github.com/home-assistant/app-speech-to-phrase/issues + about: Each app has its own repository. Please report issues with the Speech-to-Phrase app there. + - name: Report a bug with the Terminal & SSH app + url: https://github.com/home-assistant/app-ssh/issues + about: Each app has its own repository. Please report issues with the Terminal & SSH app there. + - name: Report a bug with the VLC app + url: https://github.com/home-assistant/app-vlc/issues + about: Each app has its own repository. Please report issues with the VLC app there. + - name: Report a bug with the Whisper app + url: https://github.com/home-assistant/app-whisper/issues + about: Each app has its own repository. Please report issues with the Whisper app there. + - name: Report a bug with the Z-Wave JS app + url: https://github.com/home-assistant/app-zwave-js/issues + about: Each app has its own repository. Please report issues with the Z-Wave JS app there. - name: Report a bug with the UI, Frontend or Dashboards url: https://github.com/home-assistant/frontend/issues about: This is the issue tracker for our backend. Please report issues with the UI in the frontend repository. - name: Report a bug with Home Assistant url: https://github.com/home-assistant/core/issues - about: This is the issue tracker for our apps (formerly known as add-ons). Please report issues with the core software in the core repository. + about: This repository holds the official apps (formerly known as add-ons). Please report issues with the core software in the core repository. - name: Report incorrect or missing information on our website url: https://github.com/home-assistant/home-assistant.io/issues about: Our documentation has its own issue tracker. Please report issues with the website there. diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml index 62d1a3122..5202e0bc3 100644 --- a/.github/ISSUE_TEMPLATE/task.yml +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -1,4 +1,5 @@ --- +# yamllint disable rule:line-length name: Task description: For staff only - Create a task type: Task @@ -8,22 +9,17 @@ body: value: | ## ⚠️ RESTRICTED ACCESS - **This form is restricted to Open Home Foundation staff and - authorized contributors only.** + **This form is restricted to Open Home Foundation staff and authorized contributors only.** If you are a community member wanting to contribute, please: - - For bug reports: Use the - [bug report form](https://github.com/home-assistant/addons/issues/new - ?template=bug_report.yml) - - For feature requests: Submit to - [Feature Requests](https://github.com/orgs/home-assistant/discussions) + - For bug reports: Use the issue tracker of the app's own repository, listed on the [new issue page](https://github.com/home-assistant/apps/issues/new/choose) + - For feature requests: Submit to [Feature Requests](https://github.com/orgs/home-assistant/discussions) --- ### For authorized contributors - Use this form to create tasks for development work, improvements, - or other actionable items that need to be tracked. + Use this form to create tasks for development work, improvements, or other actionable items that need to be tracked. - type: textarea id: description attributes: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..6f2ee6192 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ + + +## Proposed change + + + +## Checklist + +- [ ] This change does not belong to an app that has its own repository. diff --git a/.github/workflows/restrict-task-creation.yml b/.github/workflows/restrict-task-creation.yml index e654acbdc..2d72ec2b7 100644 --- a/.github/workflows/restrict-task-creation.yml +++ b/.github/workflows/restrict-task-creation.yml @@ -44,9 +44,10 @@ jobs: `Task issues are restricted to Open Home Foundation ` + `staff and authorized contributors.\n\n` + `If you would like to:\n` + - `- Report a bug: Please use the ` + - `[bug report form](https://github.com/home-assistant/` + - `addons/issues/new?template=bug_report.yml)\n` + + `- Report a bug: Please use the issue tracker of the ` + + `app's own repository, listed on the ` + + `[new issue page](https://github.com/home-assistant/` + + `apps/issues/new/choose)\n` + `- Request a feature: Please submit to ` + `[Feature Requests](` + `https://github.com/orgs/home-assistant/discussions)\n\n` + diff --git a/README.md b/README.md index 5d1128b67..ba228de13 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,8 @@ You have several options to get them answered: - The Home Assistant [Community Forum][forum]. - Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]. -In case you've found a bug, please [open an issue on our GitHub][issue]. +In case you've found a bug, please open an issue in the app's own repository. +The [new issue page][issue] links to the repository of each app. ## Developing your own apps @@ -90,6 +91,6 @@ about developing an app, please see our [discord]: https://www.home-assistant.io/join-chat [forum]: https://community.home-assistant.io -[issue]: https://github.com/home-assistant/addons/issues +[issue]: https://github.com/home-assistant/apps/issues/new/choose [reddit]: https://reddit.com/r/homeassistant [dev-docs]: https://contributors.home-assistant.io/apps/