Files
core/homeassistant/components/splunk/quality_scale.yaml
T

161 lines
4.8 KiB
YAML

rules:
# Bronze
action-setup:
status: exempt
comment: |
Integration does not provide custom actions.
appropriate-polling:
status: exempt
comment: |
Event-driven push integration that listens to state changes, no polling occurs.
brands: done
common-modules: done
config-entry-unloading: done
config-flow-test-coverage: done
config-flow: done
dependency-transparency: done
docs-actions:
status: exempt
comment: |
Integration does not provide custom actions.
docs-conditions:
status: exempt
comment: This integration does not have any conditions.
docs-high-level-description: done
docs-installation-instructions: done
docs-removal-instructions: done
docs-triggers:
status: exempt
comment: This integration does not have any triggers.
entity-event-setup:
status: exempt
comment: |
Integration does not create entities.
entity-unique-id:
status: exempt
comment: |
Integration does not create entities.
has-entity-name:
status: exempt
comment: |
Integration does not create entities.
integration-owner: done
reauthentication-flow: done
runtime-data:
status: exempt
comment: |
Integration has no per-entry runtime state to store. The only data in
hass.data is a YAML entity filter bridged from async_setup to
async_setup_entry; no platforms or other code accesses it afterward.
test-before-configure: done
test-before-setup: done
test-coverage: done
unique-config-entry: done
# Silver
action-exceptions:
status: exempt
comment: |
Integration does not provide custom actions.
docs-configuration-parameters:
status: exempt
comment: |
Integration does not have an options flow.
docs-installation-parameters: done
entity-unavailable:
status: exempt
comment: |
Integration does not create entities.
log-when-unavailable:
status: exempt
comment: |
Integration does not create entities.
parallel-updates:
status: exempt
comment: |
Integration does not create entities.
# Gold
devices:
status: exempt
comment: |
Integration does not create devices.
diagnostics: done
discovery:
status: exempt
comment: |
Integration does not support automatic discovery.
discovery-update-info:
status: exempt
comment: |
Integration does not support discovery.
docs-data-update:
status: todo
comment: |
Document how the integration pushes state changes to Splunk via the HTTP Event Collector.
docs-examples:
status: todo
comment: |
Add example automations or use of the Splunk data in the documentation.
docs-known-limitations:
status: todo
comment: |
Document known limitations, such as the integration only sending data (no entities) and YAML entity filtering being the only filtering mechanism.
docs-supported-devices:
status: exempt
comment: |
Integration is a service and does not support physical devices.
docs-supported-functions:
status: todo
comment: |
Document what the integration does (forwarding state changes to Splunk) and the entity filtering options.
docs-troubleshooting:
status: todo
comment: |
Add a troubleshooting section covering connection and authentication errors.
docs-use-cases:
status: todo
comment: |
Document use cases for sending Home Assistant state changes to Splunk.
dynamic-devices:
status: exempt
comment: |
Integration does not create devices.
entity-category:
status: exempt
comment: |
Integration does not create entities.
entity-device-class:
status: exempt
comment: |
Integration does not create entities.
entity-disabled-by-default:
status: exempt
comment: |
Integration does not create entities.
entity-translations:
status: exempt
comment: |
Integration does not create entities.
exception-translations: done
icon-translations:
status: exempt
comment: |
Integration does not create entities.
reconfiguration-flow: done
repair-issues: done
stale-devices:
status: exempt
comment: |
Integration does not create devices.
# Platinum
async-dependency:
status: todo
comment: |
Verify all methods in hass-splunk library at https://github.com/Bre77/hass_splunk are truly async with no blocking calls or synchronous I/O operations.
inject-websession: done
strict-typing:
status: todo
comment: |
Add py.typed marker to hass-splunk library, add comprehensive type hints to all functions and methods in both library and integration, use custom typed ConfigEntry, add integration to homeassistant/components/.strict-typing file, and verify mypy passes. This should be done after runtime-data is implemented.