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

Set Jewish Calendar quality scale #120604

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Set Jewish Calendar quality scale #120604

wants to merge 3 commits into from

Conversation

tsvi
Copy link
Contributor

@tsvi tsvi commented Jun 26, 2024

Proposed change

Set Jewish Calendar quality scale

Silver 馃

  • Connection/configuration is handled via a component.
  • Set an appropriate SCAN_INTERVAL (if a polling integration)
  • Raise PlatformNotReady if unable to connect during platform setup (if appropriate)
  • 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. (docs)
  • 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.
  • Operations like service calls and entity methods (e.g. Set HVAC Mode) have proper exception handling. Raise ServiceValidationError on invalid user input and raise HomeAssistantError for other failures such as a problem communicating with a device. Read more about raising exceptions.
  • Set available property to False if appropriate (docs)
  • Entities have unique ID (if available) (docs)

Gold 馃

This is a solid integration that is able to survive poor conditions and can be configured via the user interface.

  • Satisfying all Silver level requirements.
  • Configurable via config entries.
    • Don't allow configuring already configured device/service (example: no 2 entries for same hub)
    • Discoverable (if available)
    • Set unique ID in config flow (if available)
    • Raise ConfigEntryNotReady if unable to connect during entry setup (if appropriate)
  • Entities have device info (if available) (docs)
  • Tests
    • Full test coverage for the config flow
    • Above average test coverage for all integration modules
    • Tests for fetching data from the integration and controlling it (docs)
  • Has a code owner (docs)
  • Entities only subscribe to updates inside async_added_to_hass and unsubscribe inside async_will_remove_from_hass (docs)
  • Entities have correct device classes where appropriate (docs)
  • Supports entities being disabled and leverages Entity.entity_registry_enabled_default to disable less popular entities (docs)
  • If the device/service API can remove entities, the integration should make sure to clean up the entity and device registry.
  • When communicating with a device or service, the integration implements the diagnostics platform which redacts sensitive information.

Platinum 馃弳

Best of the best. The integration is completely async, meaning it's super fast. Integrations that reach platinum level will require approval by the code owner for each PR.

  • Satisfying all Gold level requirements.
  • Set appropriate PARALLEL_UPDATES constant (docs)
  • Support config entry unloading (called when config entry is removed)
  • Integration + dependency are async (docs)
  • Uses aiohttp or httpx and allows passing in websession (if making HTTP requests)
  • Handles expired credentials (if appropriate)

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@tsvi
Copy link
Contributor Author

tsvi commented Jun 26, 2024

@joostlek not sure regarding:

Entities only subscribe to updates inside async_added_to_hass and unsubscribe inside async_will_remove_from_hass

I see that in binary sensor, but in sensor we don't use these methods. Maybe next step is adding a coordinator so we can move to gold?

@tsvi tsvi marked this pull request as ready for review June 26, 2024 20:23
@joostlek
Copy link
Member

For what quality are you aiming

@tsvi
Copy link
Contributor Author

tsvi commented Jun 26, 2024

At this point gold. At a later stage I do want to get to platinum, but the library will need some extensive rework for that. Will probably take a few months

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants