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.

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

Already on GitHub? Sign in to your account

Support Integration Quality Scale: Platinum 馃弳 #206

Open
6 of 7 tasks
iMicknl opened this issue Aug 5, 2020 · 0 comments
Open
6 of 7 tasks

Support Integration Quality Scale: Platinum 馃弳 #206

iMicknl opened this issue Aug 5, 2020 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone

Comments

@iMicknl
Copy link
Owner

iMicknl commented Aug 5, 2020

Integration Quality Scale

The Integration Quality Scale scores each integration based on the code quality and user experience. Each level of the quality scale consists of a list of requirements. If an integration matches all requirements, it's considered to have reached that level.

https://developers.home-assistant.io/docs/integration_quality_scale_index/

Describe the solution you'd like
Would be great to make sure we reach the platinum status when we make a PR to core!

Additional context
I did scan the list quickly and it looks like the following requirements are not met yet.

Silver 馃

  • Handles expiration of auth credentials. Refresh if possible or print correct error and fail setup. If based on a config entry, should trigger a new config entry flow to re-authorize.
  • Handles internet unavailable. Log a warning once when unavailable, log once when reconnected.
  • Handles device/service unavailable. Log a warning once when unavailable, log once when reconnected.

Gold 馃

  • Tests for fetching data from the integration and controlling it (docs)
  • Supports entities being disabled and leverages Entity.entity_registry_enabled_default to disable less popular entities (docs) (this could be used for Alarm Control Panel using internal alarm controller)
  • If the device/service API can remove entities, the integration should make sure to clean up the entity and device registry.

Platinum 馃弳

  • Uses aiohttp and allows passing in websession (if making HTTP requests)

We should move larger work items to a separate issues at some point.

@iMicknl iMicknl added the enhancement New feature or request label Aug 5, 2020
@iMicknl iMicknl added this to the core release milestone Aug 26, 2020
@iMicknl iMicknl added help wanted Extra attention is needed and removed no-issue-activity labels Sep 27, 2020
Repository owner deleted a comment from github-actions bot Sep 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant