Record Plugwise Quality Scale #131888
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,109 @@ | ||||||
| rules: | ||||||
| ## Bronze | ||||||
| config-flow: done | ||||||
| test-before-configure: done | ||||||
| unique-config-entry: | ||||||
| status: todo | ||||||
| comment: Add tests preventing second entry for same device | ||||||
| config-flow-test-coverage: | ||||||
| status: todo | ||||||
| comment: Cover test_form and zeroconf | ||||||
| runtime-data: | ||||||
| status: todo | ||||||
| comment: Clean up test_init for testing internals | ||||||
| test-before-setup: done | ||||||
| appropriate-polling: | ||||||
| status: todo | ||||||
| comment: Clean up coordinator (L71) check for mypy happiness | ||||||
| entity-unique-id: done | ||||||
| has-entity-name: | ||||||
| status: todo | ||||||
| comment: Clean up climate (already in superclass) | ||||||
| entity-event-setup: done | ||||||
| dependency-transparency: done | ||||||
| action-setup: | ||||||
| status: todo | ||||||
| comment: Check if we have these, otherwise exempt | ||||||
| common-modules: | ||||||
| status: todo | ||||||
| comment: Verify entity for async_added_to_hass usage (discard?) | ||||||
| docs-high-level-description: done | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. Updated as future todo |
||||||
| docs-installation-instructions: done | ||||||
|
There was a problem hiding this comment. I am missing the default config flow setup snippet and I personally think the text is a bit too literal. I think there is room for improvement here. There was a problem hiding this comment. Linked to PR-in-progress / set to todo There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. Docs PR was just closed, but let's leave it as todo to make a process out of this. E.g. set to todo, create small update PR to indicate (with reference PR to docs) that it's done. |
||||||
| docs-removal-instructions: | ||||||
| status: todo | ||||||
| comment: Docs PR 36055 | ||||||
| docs-actions: done | ||||||
CoMPaTech marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| brands: done | ||||||
| ## Silver | ||||||
| config-entry-unloading: done | ||||||
| log-when-unavailable: done | ||||||
| entity-unavailable: done | ||||||
| action-exceptions: | ||||||
| status: todo | ||||||
| comment: Climate exception on ValueError should be ServiceValidationError | ||||||
| reauthentication-flow: | ||||||
| status: exempt | ||||||
| comment: The hubs have a hardcoded `Smile ID` printed on the sticker used as password, it can not be changed | ||||||
| parallel-updates: | ||||||
| status: todo | ||||||
| comment: Using coordinator, but required due to mutable platform | ||||||
| test-coverage: | ||||||
| status: todo | ||||||
| comment: Consider using snapshots + consistency in setup calls + add numerical tests + use fixtures | ||||||
|
There was a problem hiding this comment. Note that the snapshots was an opinionated comment. Snapshots are a great way to fixate data structures and to see what fixture creates what and what the effect of changes on them are There was a problem hiding this comment. I interpreted it that way, hence noting as a consideration :) |
||||||
| integration-owner: done | ||||||
| docs-installation-parameters: | ||||||
| status: todo | ||||||
| comment: Docs PR 36087 (partial) + todo rewrite generically | ||||||
| docs-configuration-parameters: | ||||||
| status: exempt | ||||||
| comment: Plugwise has no options flow | ||||||
| ## Gold | ||||||
| entity-translations: | ||||||
| status: todo | ||||||
| comment: Clean up name where not needed, remove translation key on deviceclasses | ||||||
| entity-device-class: done | ||||||
| devices: done | ||||||
| entity-category: done | ||||||
| entity-disabled-by-default: done | ||||||
| discovery: done | ||||||
| stale-devices: done | ||||||
| diagnostics: done | ||||||
| exception-translations: | ||||||
| status: todo | ||||||
| comment: Add coordinator, util and climate exceptions | ||||||
| icon-translations: done | ||||||
| reconfiguration-flow: | ||||||
| status: todo | ||||||
| comment: This integration does not have any reconfiguration steps (yet) investigate how/why | ||||||
| dynamic-devices: | ||||||
| status: todo | ||||||
| comment: Add missing logic to button for unloading and creation | ||||||
| discovery-update-info: done | ||||||
| repair-issues: | ||||||
| status: exempt | ||||||
| comment: This integration does not have repairs | ||||||
| docs-use-cases: | ||||||
| status: todo | ||||||
| comment: Check for completeness | ||||||
| docs-supported-devices: | ||||||
| status: todo | ||||||
| comment: The list is there but could be improved for readability | ||||||
| docs-supported-functions: | ||||||
| status: todo | ||||||
| comment: Check for completeness | ||||||
| docs-data-update: | ||||||
| status: todo | ||||||
| comment: Docs PR 36055 | ||||||
| docs-known-limitations: | ||||||
| status: todo | ||||||
| comment: Partial in 36087 but could be more elaborat | ||||||
| docs-troubleshooting: | ||||||
| status: todo | ||||||
| comment: Check for completeness | ||||||
| docs-examples: | ||||||
| status: todo | ||||||
| comment: Check for completeness | ||||||
| ## Platinum | ||||||
| async-dependency: done | ||||||
| inject-websession: done | ||||||
| strict-typing: done | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -819,7 +819,6 @@ class Rule: | |
| "plaato", | ||
| "plant", | ||
| "plex", | ||
| "plum_lightpad", | ||
| "pocketcasts", | ||
| "point", | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I must say, when I read the docs, I am missing what Plugwise is. I think we should make the docs more accessible for users who are looking to buy a new device for example. We never really explain what plugwise is or what a smile is for example
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will create a new docs PR for this (already spotted it myself as well) - set to todo