Improve quality scale for Swiss Public Transport #131711
Draft
+93
−1
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.
Proposed change
Bronze
config-flow
- Integration needs to be able to be set up via the UIdata-description
to give context to fieldsConfigEntry.data
andConfigEntry.options
correctlytest-before-configure
- Test a connection in the config flowunique-config-entry
- Don't allow the same device or service to be able to be set up twiceconfig-flow-test-coverage
- Full test coverage for the config flowruntime-data
- Use ConfigEntry.runtime_data to store runtime datatest-before-setup
- Check during integration initialization if we are able to set it up correctlyappropriate-polling
- If it's a polling integration, set an appropriate polling intervalentity-unique-id
- Entities have a unique IDhas-entity-name
- Entities use has_entity_name = Trueentity-event-setup
- Entities event setupdependency-transparency
- Dependency transparencyaction-setup
- Service actions are registered in async_setupcommon-modules
- Place common patterns in common modulesdocs-high-level-description
- The documentation includes a high-level description of the integration brand, product, or servicedocs-installation-instructions
- The documentation provides step-by-step installation instructions for the integration, including, if needed, prerequisitesdocs-removal-instructions
- The documentation provides removal instructionsdocs-actions
- The documentation describes the provided service actions that can be usedbrands
- Has branding assets available for the integrationSilver
config-entry-unloading
- Support config entry unloadinglog-when-unavailable
- If internet/device/service is unavailable, log once when unavailable and once when back connectedentity-unavailable
- Mark entity unavailable if appropriateaction-exceptions
- Service actions raise exceptions when encountering failuresreauthentication-flow
- Reauthentication flowparallel-updates
- Set Parallel updatestest-coverage
- Above 95% test coverage for all integration modulesintegration-owner
- Has an integration ownerdocs-installation-parameters
- The documentation describes all integration installation parametersdocs-configuration-parameters
- The documentation describes all integration configuration optionsGold
entity-translations
- Entities have translated namesentity-device-class
- Entities use device classes where possibledevices
- The integration creates devicesentity-category
- Entities are assigned an appropriate EntityCategoryentity-disabled-by-default
- Integration disables less popular (or noisy) entitiesdiscovery
- Can be discoveredstale-devices
- Clean up stale devicesdiagnostics
- Implements diagnosticsexception-translations
- Exception messages are translatableicon-translations
- Icon translationsreconfiguration-flow
- Integrations should have a reconfigure flowdynamic-devices
- Devices added after integration setupdiscovery-update-info
- Integration uses discovery info to update network informationrepair-issues
- Repair issues and repair flows are used when user intervention is neededdocs-use-cases
- The documentation describes use cases to illustrate how this integration can be useddocs-supported-devices
- The integration documents known supported / unsupported devicesdocs-supported-functions
- The documentation describes the supported functionality, including entities, and platformsdocs-data-update
- The documentation describes how data is updateddocs-known-limitations
- The documentation describes known limitations of the integration (not to be confused with bugs)docs-troubleshooting
- The documentation provides troubleshooting informationdocs-examples
- The documentation provides automation examples the user can use.Platinum
async-dependency
- Dependency is asyncinject-websession
- The integration dependency supports passing in a websessionstrict-typing
- Strict typingType of change
Additional information
Checklist
ruff format homeassistant tests
)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest
.requirements_all.txt
.Updated by running
python3 -m script.gen_requirements_all
.To help with the load of incoming pull requests: