Back to all reviewers

configuration status accuracy

home-assistant/core
Based on 3 comments
Yaml

Ensure that configuration file status values accurately reflect the actual implementation state. Use 'done' only when features are fully implemented, 'todo' for planned but unimplemented features, and 'exempt' for features that don't apply to the integration. Always provide clear, descriptive comments explaining why items are marked as exempt.

Configurations Yaml

Reviewer Prompt

Ensure that configuration file status values accurately reflect the actual implementation state. Use ‘done’ only when features are fully implemented, ‘todo’ for planned but unimplemented features, and ‘exempt’ for features that don’t apply to the integration. Always provide clear, descriptive comments explaining why items are marked as exempt.

Example from quality scale configuration:

rules:
  inject-websession: todo  # Not 'done' if not actually implemented
  entity-event-setup:
    status: exempt
    comment: no explicit subscriptions to events
  dynamic-devices:
    status: exempt
    comment: |
      No dynamic devices possible.

This prevents misleading configuration states and helps maintainers understand the true implementation status and reasoning behind exemptions.

3
Comments Analyzed
Yaml
Primary Language
Configurations
Category

Source Discussions