Skip to content

Add CLAUDE.md with project guidance - #190

Merged
iantrich merged 2 commits into
masterfrom
claude/add-claude-md
Nov 16, 2026
Merged

iantrich merged 2 commits into
masterfrom
claude/add-claude-md

Conversation

@iantrich

Copy link
Copy Markdown
Member

Summary

Adds a CLAUDE.md so Claude (the new PR review, @claude mentions and Dependabot evaluation) has project context. It is documentation only, no code changes.

It covers the repo layout, the dev and test commands (including the online test marker and why it needs -p no:homeassistant), the Python 3.13/3.14 split between source and tests, mypy/ruff/black expectations, which files must stay in sync when config options change (config flow, YAML import, strings.json, translations, README), how to add feed test data, how releases are versioned, and which CI checks must pass.

Everything in it is taken from pyproject.toml, the pre-commit config, the scripts, the CI workflows and the existing tests. Please correct anything that doesn't match how you work, since the file steers automated reviews.


Generated by Claude Code

@claude

claude Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

Claude finished @iantrich's task in 17s —— View job


Review of PR #190: Add CLAUDE.md

  • Read CLAUDE.md and checked its claims against the repo

Summary: This is a docs-only change and I found nothing that needs fixing before merge. I checked the claims in CLAUDE.md against the repo and they match:

  • Layout: The module list, the translations/ languages (en, de, el) and tests/constants.py all exist.
  • Commands: scripts/setup and scripts/develop do what the file says. addopts = "-m 'not online'" and the online marker note about -p no:homeassistant are in pyproject.toml.
  • Python split: requires-python >=3.14, the CI "Python 3.13 syntax" job, and hacs.json pinning HA 2025.8.0 are consistent with the doc.
  • Releases: bumpver updates pyproject.toml, manifest.json and const.py (VERSION), as described.
  • Stubs pin: homeassistant-stubs and pytest-homeassistant-custom-component are pinned together in pyproject.toml, matching the doc.

Optional suggestions (none of these block the PR):

  1. The "Python versions" bullet could mention that pyproject.toml declares requires-python >=3.14. A reviewer could then see why the integration cannot be installed on 3.13 from the package metadata, while still having to run there under HA.
  2. CI job names can drift. You could say "the checks in .github/workflows/pull_request.yml" instead of quoting display names such as "Code Quality (3.14)".
  3. The "no blocking I/O" bullet could name the pattern the code uses (for example executor jobs or HA's aiohttp session). That would let automated reviews flag violations more reliably.

I did not run the test suite, since the PR changes no code.
· branch claude/add-claude-md

@iantrich
iantrich marked this pull request as ready for review November 16, 2026 18:34
@claude

claude Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

Claude finished @iantrich's task in 13s —— View job


Review of PR #190: Add CLAUDE.md

  • Read CLAUDE.md and checked its claims against the repo

Summary: This is a docs-only change and nothing blocks merge. The layout, commands, online marker note, Python 3.13/3.14 split and translations list all match the repo.

Optional suggestions

  1. Python versions bullet: pyproject.toml declares requires-python = ">=3.14", while the integration has to run on 3.13 under HA 2025.8. Saying so would stop a reviewer from "fixing" the mismatch.
  2. CI job names: Names like "Code Quality (3.14)" can drift. Pointing to the checks in .github/workflows/pull_request.yml is more durable.
  3. Blocking I/O bullet: The code uses requests (in fetch.py, coordinator.py and config_flow.py) and runs it through hass.async_add_executor_job. Naming that pattern would let automated reviews flag any new direct requests call in async code. It could also say that fetch.py sets a timeout.

I did not run the test suite, since the PR changes no code.
· branch claude/add-claude-md

Note the intentional requires-python vs Python 3.13 runtime mismatch, describe the
executor-job pattern for blocking requests calls, and point to the CI workflow
files instead of quoting job names.

Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01FvqVzggqxfrUFgMdzvkQZm
@claude

claude Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

Claude finished @iantrich's task in 12s —— View job


Review of PR #190: Add CLAUDE.md

  • Read CLAUDE.md at the current head and checked its claims against the repo

Summary: Docs-only change, nothing blocks merge. The latest commit (3b2e1ec) already includes the three optional suggestions from my earlier reviews, so I have no new ones.

  • Python versions bullet: It now states requires-python = ">=3.14", that the mismatch is intentional, and that the integration must stay 3.13-valid.
  • CI references: It points to .github/workflows/ and pull_request.yml instead of quoting job display names.
  • Blocking I/O bullet: It matches the code. fetch.py:75 calls session.get(..., timeout=REQUEST_TIMEOUT). coordinator.py:120 and config_flow.py:606 run the fetch via hass.async_add_executor_job.
  • Layout: The translations/ languages (en, de, el), scripts/setup, scripts/develop, run-hass.sh, test_hass/, package.yaml and tests/constants.py all exist.

I did not run the test suite, since the PR changes no code.
· branch claude/add-claude-md

@iantrich
iantrich merged commit 5ce8124 into master Nov 16, 2026
9 checks passed
@iantrich
iantrich deleted the claude/add-claude-md branch November 16, 2026 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants