Instruction file imported from ruaan-deysel/ha-unraid (.github/instructions/yaml.instructions.md). Copyright stays with the author.

YAML Configuration Files Guidelines — ha-unraid

Name: yaml
Author: ruaan-deysel

Refer to AGENTS.md for full project documentation.

quality_scale.yaml

Self-assessment against the HA Integration Quality Scale.

Structure

rules:
  rule-name:
    status: done | todo | exempt
    comment: Explanation (required for exempt/todo)

Tiers

Bronze: Minimum requirements for all integrations Includes entity-unavailable and integration-owner.
Silver: Improved reliability and robustness Includes docs-actions and entity-event-setup.
Gold: Best user experience
Platinum: Highest standards

Rules

Update status when implementing new quality scale requirements
Always include a comment explaining exempt or todo status
Current target: Platinum level
Key outstanding item: test-coverage must be >=95%
Review after adding new features to ensure all quality scale rules still apply

{ "ocm": "1", "id": "ruaan-deysel-ha-unraid-yaml-instructions", "kind": "skill", "name": "yaml", "description": "Refer to `AGENTS.md` for full project documentation.", "publisher": "ruaan-deysel", "version": "1.0.0", "capabilities": { "domains": [ "general" ], "tags": [ "skill-md", "github-instructions" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Refer to `AGENTS.md` for full project documentation." ], "primary": false, "metadata": { "source": { "provider": "github-instructions", "repository": "https://github.com/ruaan-deysel/ha-unraid", "path": ".github/instructions/yaml.instructions.md", "ref": "53d3c311c425dd94d9f42b2e1f573e2f31470f40", "url": "https://github.com/ruaan-deysel/ha-unraid/blob/53d3c311c425dd94d9f42b2e1f573e2f31470f40/.github/instructions/yaml.instructions.md", "key": "ruaan-deysel/ha-unraid/.github/instructions/yaml.instructions.md" }, "applies_to": "custom_components/unraid/quality_scale.yaml" }, "instructions": "# YAML Configuration Files Guidelines — ha-unraid\n\nRefer to `AGENTS.md` for full project documentation.\n\n## quality_scale.yaml\n\nSelf-assessment against the [HA Integration Quality Scale](https://developers.home-assistant.io/docs/core/integration-quality-scale/).\n\n### Structure\n\n```yaml\nrules:\n rule-name:\n status: done | todo | exempt\n comment: Explanation (required for exempt/todo)\n```\n\n### Tiers\n\n- **Bronze**: Minimum requirements for all integrations\n Includes `entity-unavailable` and `integration-owner`.\n- **Silver**: Improved reliability and robustness\n Includes `docs-actions` and", "cost": { "context_tokens": 252 } }

yaml

About

YAML Configuration Files Guidelines — ha-unraid

quality_scale.yaml

Structure

Tiers

Rules

Use it

Manifest

Reviews