Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add detailed reporting guidelines for UniFi Protect integration issues #293

Merged
merged 2 commits into from
Jan 31, 2025
Merged

Add detailed reporting guidelines for UniFi Protect integration issues #293

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9fee6c
Add detailed reporting guidelines for UniFi Protect integration issues
RaHehl Jan 31, 2025
37fd296
Update data/github/issue_context.yaml
RaHehl Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions data/github/issue_context.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
"integration: demo": >-
This is a demo integration.
"integration: unifiprotect": >-
Please make sure this isn't a duplicate issue by searching the existing issues, especially keep an eye on the latest issues and pull requests.

https://github.com/home-assistant/core/issues?q=%20label%3A%22integration%3A%20unifiprotect%22%20
Comment on lines +4 to +6
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not unifiprotect specific and should not be in here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically, I’m with you on that. Where can this generally be implemented? Including a link for the Integration issues would be great—I definitely need a solution for this urgently!
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just kidding: Ideally, there should be a points system like with a driver's license, where accumulating too many points would block the creation of new bugs!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/home-assistant/service-hub/blob/main/services/bots/src/github-webhook/handlers/issue_links.ts
That would be the place for it IMO.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a better place would be: https://github.com/home-assistant/core/blob/dev/.github/ISSUE_TEMPLATE/bug_report.yml?plain=1

With something like:

"Before opening a new issue, please make sure it isn't a duplicate by reviewing existing issues and pull requests—especially the latest ones. For instance, if you encounter a problem with the unifiprotect integration, check for similar reports by filtering with the label integration: unifiprotect. You can see an example here:
https://github.com/home-assistant/core/issues?q=label%3A%22integration%3A%20unifiprotect%22
Also, remember to look at recently closed issues and pull requests, as your problem might have been addressed there."


Then make sure your report includes the following information:

1. UniFi OS version
2. Protect version
3. Hardware running Protect (Cloud Key Gen2+, UDM-Pro, etc.)
Comment on lines +10 to +12
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How to find this information are missing from the integration documentation.

Copy link
Contributor Author

@RaHehl RaHehl Feb 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand the question, but if someone needs a guide for this, maybe they shouldn't be creating bugs in the first place. The information is right there on the Dashboard —impossible to miss!

image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Impossible to miss when you know what to look for and where to look.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we perhaps agree on the following:

  1. UniFi OS version
  2. Protect version
  3. Hardware running Protect (Cloud Key Gen2+, UDM-Pro, etc.)

Note: Both the UniFi OS version and the Protect version can be found on the web dashboard as well as under the "control plane" section in Settings.

4. [If applicable, error logs](https://www.home-assistant.io/docs/configuration/troubleshooting/#debug-logs-and-diagnostics)
"integration: zha": >-
Please make sure your report includes the following things:

Expand Down