AGENTS.md
Guides an AI agent on editing translation files and coding practices for a Home Assistant custom component.
What this file does
Guides an AI agent on editing translation files and coding practices for a Home Assistant custom component.
When to use it
- You want an AI agent to follow KISS and DRY principles
- You need automated handling of translation file edits
- You require all code comments and docs in English
- You are setting up agent instructions for a Home Assistant integration
Assumes this stack
AGENTS.md
Automated Agent Instructions
Directory and File Handling
- In the
custom_components/polleninformation/translations/directory, only edit theen.jsonfile for content changes (new strings, rewording, etc.). Mechanical changes required for validation compliance (e.g. HACS rules) may be applied across all translation files.
Coding Principles
- All code must follow the KISS (Keep It Simple, Stupid) and DRY (Don't Repeat Yourself) principles.
Comments and Documentation
- All code should be commented for clarity.
- All documentation, including comments, must be written in English.
What's inside
3 sections: directory/file handling, coding principles, comments and documentation rules.
Change this for your project
- Replace
custom_components/polleninformation/translations/with your own component path - Replace
en.jsonwith your default translation file name
Where it goes
Save as AGENTS.md in your repository root. Read by Codex, Cursor and other agents that follow the AGENTS.md convention.
Related Documents
Browser-only development
Guides AI assistants on an Electron + React + TypeScript desktop app for browsing and organizing AI-generated images locally.
Claude Agents — Reference & Recommendations
Catalogues 40+ Claude agents and marketing skills for building a cat adoption charity landing page, with a ready-to-paste prompt and backend API reference.
Golden DKG Prototype -- Master Plan
Defines an 8-phase implementation plan for a Rust prototype of the Golden non-interactive DKG protocol using BLS12-381 and tokio.
Swarms Examples Index
Lists 60+ example scripts for building single and multi-agent systems with the Swarms framework, organized by category and use case.