Skip to content

CLAUDE.md

Latest commit

 

History

History
36 lines (28 loc) · 1.53 KB

CLAUDE.md

File metadata and controls

36 lines (28 loc) · 1.53 KB

Claude Code Instructions

This repository uses a shared AI agent instruction system. All instructions are in AGENTS.md.

Read AGENTS.md completely before starting any work. It contains:

  • Project overview and integration identifiers
  • Package structure and architectural rules
  • Code style, validation commands, and quality expectations
  • Home Assistant patterns (config flow, coordinator, entities, services)
  • Error recovery strategy and breaking change policy
  • Workflow rules (scope management, translations, documentation)

Quick Reference

  • Domain: flameconnect
  • Title: FlameConnect
  • Class prefix: FlameConnect
  • Main code: custom_components/flameconnect/
  • Validate: script/check (type-check + lint + spell)
  • Test: script/test
  • Run HA: ./script/develop

Path-Specific Instructions

Additional domain-specific guidance is available in .github/instructions/*.instructions.md. These files use applyTo globs to indicate which files they cover. Consult the relevant instruction file when working on specific file types:

  • python.instructions.md — Python style, async patterns, HA imports
  • entities.instructions.md — Entity platform patterns, inheritance
  • config_flow.instructions.md — Config flow, reauth, discovery
  • coordinator.instructions.md — DataUpdateCoordinator patterns
  • api.instructions.md — API client, exception hierarchy
  • services_yaml.instructions.md — Service action definitions
  • translations.instructions.md — Translation file structure