Light Manager Air Integration Guidelines
Defines commit, code style, and release conventions for a Home Assistant integration project, including a sync requirement between two config files.
What this file does
Defines commit, code style, and release conventions for a Home Assistant integration project, including a sync requirement between two config files.
When to use it
- Starting a Home Assistant custom integration with Claude Code
- Setting up a project that needs mirrored CLAUDE.md and agent guidelines
- Establishing release tagging and GitHub CLI workflow for a Python project
- Enforcing commit message and naming conventions in a team or solo repo
Assumes this stack
Light Manager Air Integration Guidelines
This file must stay in sync with
CLAUDE.md. Whenever you change one, mirror the same change in the other so both tools continue to work correctly.
Commit Guidelines
- Do NOT include "Generated with Claude Code" or similar notes in commit messages
- Commit messages should be clear, concise, and descriptive
- Use the imperative mood in commit messages (e.g., "Add feature" not "Added feature")
- No need for co-author attribution to Claude
Code Style Guidelines
General Principles
- Maintain clean, readable, and consistent code
- Follow the Home Assistant code style guidelines
- Keep methods small and focused on a single task
- Use type hints where appropriate
- Write unit tests for new functionality
Comments
- Write comments in English only
- Add comments only when necessary to explain complex logic
- Don't comment obvious code
- Use docstrings for classes and public methods
Naming Conventions
- Use descriptive names for classes, methods, and variables
- Follow Python naming conventions:
- snake_case for methods and variables
- CamelCase for classes
- UPPER_CASE for constants
Release Process
Tag and Release Format
- Tags should be created without "v" prefix:
1.2.2(notv1.2.2) - The release title should simply be the version number:
1.2.2
Creating a Release with GitHub CLI
# Create tag
git tag -a 1.2.2 -m "Release 1.2.2 - Brief description"
git push origin 1.2.2
# Create release
gh release create 1.2.2 --title "1.2.2" --notes "# Light Manager Air Integration 1.2.2
In version 1.2.2 of the Light Manager Air Integration for Home Assistant, the following changes have been made:
## Bug fixes
- Description of changes
Thank you for your feedback and support. Enjoy the new version!"
What's inside
3 sections: Commit Guidelines, Code Style Guidelines (with 3 subsections), Release Process (with tag format and CLI example)
Change this for your project
- Replace
kmifka/hass_lmairwith your own repository name in the release notes example - Replace
Light Manager Air Integrationwith your integration's name throughout - Replace
1.2.2with your actual version number in tag and release commands
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.