Skip to content

Conversation

@raman325
Copy link
Owner

@raman325 raman325 commented Jan 30, 2026

Proposed change

Updates AGENTS.md with comprehensive documentation improvements:

New Sections

  • External repositories/directories: Documents related repositories and directories including wiki, home-assistant core/frontend, zwave-js-server, zwave-js-server-python, keymaster, and local HA config folder
  • Optimistic updates: Added section explaining when and how providers should implement optimistic coordinator updates to prevent sync loops (relevant for Z-Wave JS and similar async-cache providers)

Expanded Sections

  • Condition entities: Replaced brief mention with comprehensive table of all 5 supported domains (calendar, schedule, binary_sensor, switch, input_boolean) with behavior and use cases
  • Excluded integrations: Documented EXCLUDED_CONDITION_PLATFORMS constant and scheduler-component exclusion with validation locations

Rule Updates

  • Fixed path reference to .github/PULL_REQUEST_TEMPLATE.md
  • Added rule: "Before committing, ensure pre-commit succeeds and tests pass"

Type of change

  • Code quality improvements to existing code or addition of tests

Additional information

🤖 Generated with Claude Code

- Add optimistic updates section for providers with async value caches
- Expand condition entities documentation with all supported domains
- Add excluded integrations section (scheduler-component)
- Document EXCLUDED_CONDITION_PLATFORMS constant

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings January 30, 2026 05:08
@github-actions github-actions bot added the documentation Documentation changes label Jan 30, 2026
@github-actions github-actions bot added the code-quality Pull requests that improve code quality label Jan 30, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the AGENTS.md documentation to reflect recent changes to the codebase, specifically documenting the optimistic update pattern for async-cache providers and expanding the condition entities documentation.

Changes:

  • Added "Optimistic Updates" section with code examples showing when and how providers should implement optimistic coordinator updates to prevent sync loops
  • Expanded condition entities documentation with a comprehensive table of supported domains, excluded integrations, and validation details
  • Added external repositories section documenting relevant adjacent codebases

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@raman325 raman325 merged commit cf0b73b into main Jan 30, 2026
4 of 7 checks passed
@raman325 raman325 deleted the docs/agents-updates branch January 30, 2026 05:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code-quality Pull requests that improve code quality documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants