This file provides guidance for AI coding agents working in this repository.
- Developer Documentation overview – repository structure, local setup, folder descriptions
- Contributing Guidelines – code style, workflow, how to help; always look at this file!
- Fixture format – JSON schema for fixture definitions
- Capability types – all capability types supported in fixture definitions
- Common fixture mistakes – frequent mistakes found during fixture PR review, with before/after examples
- Fixture features – special fixture characteristics used to select test fixtures
- Fixture model & API – classes used to process fixture data; see also the model API reference
- Plugins – how import/export plugins work and how to write one
- Testing – test structure, how to run tests, CI setup
- UI / Website – frontend and Nuxt.js setup
- REST API – server-side API endpoints
- Environment variables – configuration via environment variables
For validating specific fixtures after changes:
npm run build:register
node tests/fixtures-valid.js fixtures/<manufacturer>/<fixture>.json