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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve quality scale for Swiss Public Transport #131711

Draft
wants to merge 5 commits into
base: dev
Choose a base branch
from

Conversation

miaucl
Copy link
Contributor

@miaucl miaucl commented Nov 27, 2024

Proposed change

Bronze

  • config-flow - Integration needs to be able to be set up via the UI
    • Uses data-description to give context to fields
    • Uses ConfigEntry.data and ConfigEntry.options correctly
  • test-before-configure - Test a connection in the config flow
  • unique-config-entry - Don't allow the same device or service to be able to be set up twice
  • config-flow-test-coverage - Full test coverage for the config flow
  • runtime-data - Use ConfigEntry.runtime_data to store runtime data
  • test-before-setup - Check during integration initialization if we are able to set it up correctly
  • appropriate-polling - If it's a polling integration, set an appropriate polling interval
  • entity-unique-id - Entities have a unique ID
  • has-entity-name - Entities use has_entity_name = True
  • entity-event-setup - Entities event setup
  • dependency-transparency - Dependency transparency
  • action-setup - Service actions are registered in async_setup
  • common-modules - Place common patterns in common modules
  • docs-high-level-description - The documentation includes a high-level description of the integration brand, product, or service
  • docs-installation-instructions - The documentation provides step-by-step installation instructions for the integration, including, if needed, prerequisites
  • docs-removal-instructions - The documentation provides removal instructions
  • docs-actions - The documentation describes the provided service actions that can be used
  • brands - Has branding assets available for the integration

Silver

  • config-entry-unloading - Support config entry unloading
  • log-when-unavailable - If internet/device/service is unavailable, log once when unavailable and once when back connected
  • entity-unavailable - Mark entity unavailable if appropriate
  • action-exceptions - Service actions raise exceptions when encountering failures
  • reauthentication-flow - Reauthentication flow
  • parallel-updates - Set Parallel updates
  • test-coverage - Above 95% test coverage for all integration modules
  • integration-owner - Has an integration owner
  • docs-installation-parameters - The documentation describes all integration installation parameters
  • docs-configuration-parameters - The documentation describes all integration configuration options

Gold

  • entity-translations - Entities have translated names
  • entity-device-class - Entities use device classes where possible
  • devices - The integration creates devices
  • entity-category - Entities are assigned an appropriate EntityCategory
  • entity-disabled-by-default - Integration disables less popular (or noisy) entities
  • discovery - Can be discovered
  • stale-devices - Clean up stale devices
  • diagnostics - Implements diagnostics
  • exception-translations - Exception messages are translatable
  • icon-translations - Icon translations
  • reconfiguration-flow - Integrations should have a reconfigure flow
  • dynamic-devices - Devices added after integration setup
  • discovery-update-info - Integration uses discovery info to update network information
  • repair-issues - Repair issues and repair flows are used when user intervention is needed
  • docs-use-cases - The documentation describes use cases to illustrate how this integration can be used
  • docs-supported-devices - The integration documents known supported / unsupported devices
  • docs-supported-functions - The documentation describes the supported functionality, including entities, and platforms
  • docs-data-update - The documentation describes how data is updated
  • docs-known-limitations - The documentation describes known limitations of the integration (not to be confused with bugs)
  • docs-troubleshooting - The documentation provides troubleshooting information
  • docs-examples - The documentation provides automation examples the user can use.

Platinum

  • async-dependency - Dependency is async
  • inject-websession - The integration dependency supports passing in a websession
  • strict-typing - Strict typing

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

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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @fabaff, mind taking a look at this pull request as it has been labeled with an integration (swiss_public_transport) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of swiss_public_transport can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign swiss_public_transport Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

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.

2 participants