Skip to content

feat(panel): Help & feedback page — report a bug or suggest a feature from Home Assistant - #1109

Merged
tempus2016 merged 3 commits into
mainfrom
feat/help-feedback
Oct 20, 2026
Merged

tempus2016 merged 3 commits into
mainfrom
feat/help-feedback

Conversation

@tempus2016

Copy link
Copy Markdown
Owner

Adds a Help & feedback page to the admin panel (System → Help & feedback) so a parent can report a bug or suggest a feature without leaving Home Assistant. The page builds a pre-filled GitHub issue from this repo's own issue templates and opens it in a new tab; nothing is sent from Home Assistant, the parent checks it and presses Create on GitHub.

Panel

  • Bug and feature forms that mirror bug_report.yml / feature_request.yml; required fields enforced, live character counts, draft kept in the browser across reloads, focus/caret kept through background redraws
  • Included automatically, from a new admin-only taskmate/feedback/info WebSocket command: TaskMate and HA versions, HA installation type, HACS default / custom / manual install, Lovelace mode, family counts (counts only), card design, health-check codes. Detected install answers can be corrected
  • TaskMate log entries from HA's system log (the 20 most recent warnings/errors), with names (and each part of the HA user's name), phone/person ids, signed-URL signatures, tokens and e-mail addresses redacted; preview of exactly what goes in; oldest entries dropped first to stay under GitHub's link length limit
  • Similar issues searched on GitHub as the title is typed; stale answers discarded
  • Diagnostics download (signed), Copy as Markdown (works on plain http), Search existing issues
  • Warns when the browser is running an older cached panel than the installed integration, and links to the health check when it found problems
  • Still lets you report when the integration can't answer, using the browser's versions
  • Works on phones, in dark mode, and in all 11 languages

Issue templates

GitHub only pre-fills text fields from a link and never pre-selects a drop-down, so a report would otherwise arrive with "None" in required drop-downs:

  • Bug: Home Assistant Installation Type, TaskMate Installation Method and Lovelace Mode become text fields, each listing its valid answers; Installation Method gains HACS (default)
  • Bug "reproducible" / "affected area" and feature "area" / "priority" stay drop-downs for people filing directly, but are optional; the panel writes those answers into the issue text instead
  • New test: no required template field may be a drop-down, and every value the panel sends must match the templates

Docs

New Help-and-Feedback.md (nav: Reference), linked from Troubleshooting, Admin Panel and Repairs & Diagnostics.

Testing

  • pytest 3528 passed (25 new), frontend 959 passed (34 new), ESLint / ruff / translation parity clean
  • End-to-end on the dev HA instance via browserless: 43/43 checks (both forms, generated link, log redaction with real log records, diagnostics download, draft persistence, mobile, dark, German, opening GitHub)
  • Pre-filled text fields confirmed on github.com; the new template fields can only be confirmed once this is on main

… from Home Assistant

A new System → Help & feedback page in the admin panel builds a pre-filled
GitHub issue from the repo's own issue templates and opens it for the parent
to check and submit. Nothing is sent from Home Assistant.

- Bug and feature forms mirroring bug_report.yml / feature_request.yml,
  required fields enforced, live character counts, draft kept in the browser
- Setup details filled in automatically via a new admin-only
  taskmate/feedback/info command: TaskMate and HA versions, installation
  type, HACS default/custom/manual, Lovelace mode, family counts (counts
  only), card design, health-check codes
- Detected drop-down answers can be corrected; GitHub can't pre-select
  drop-downs, so they also travel as text in Additional context
- Recent TaskMate warnings/errors from HA's system log, with names, phone and
  person ids, signed-URL signatures, tokens and e-mail addresses redacted;
  oldest entries dropped first to stay under GitHub's link length limit
- Similar-issue search on GitHub as the title is typed
- Diagnostics download, Copy as Markdown (works on plain http), search link
- Warns when the browser is running an older cached panel than the installed
  integration, and points to the health check when it found problems
- Still works when the integration can't answer, using the browser's versions
- Bug template gains a "HACS (default)" installation option
- Translated into all locales; docs page + nav entry
…link

GitHub fills text fields from an issue link but never pre-selects a
drop-down, so a panel report still arrived with "None" in three required
drop-downs.

- Bug template: Home Assistant installation type, TaskMate installation
  method and Lovelace mode are now text fields, each listing its valid
  answers, so the panel fills them in
- Bug "reproducible"/"affected area" and feature "area"/"priority" stay
  drop-downs for people filing directly on GitHub, but are optional; the
  panel writes those answers into the issue text instead
- The install answers no longer repeat in the issue text (Copy as Markdown
  keeps them, having no separate fields)
- GitHub's button is now "Create": the panel and docs say so
- Test: no required template field may be a drop-down, and the install
  answers must match the ones each text field lists
@github-actions github-actions Bot added documentation Improvements or additions to documentation ci CI, workflows, and tooling backend Python integration code cards Lovelace cards / frontend (www/*.js) translations i18n / locale strings tests Test suite labels Oct 20, 2026
@tempus2016
tempus2016 merged commit e125d3e into main Oct 20, 2026
18 checks passed
@tempus2016
tempus2016 deleted the feat/help-feedback branch October 20, 2026 13:41
@tempus2016 tempus2016 mentioned this pull request Oct 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backend Python integration code cards Lovelace cards / frontend (www/*.js) ci CI, workflows, and tooling documentation Improvements or additions to documentation tests Test suite translations i18n / locale strings

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant