docs: add CLAUDE.md and Claude skills (port-batcontrol-change, release-addon)#24
Open
MaStr wants to merge 3 commits into
Open
docs: add CLAUDE.md and Claude skills (port-batcontrol-change, release-addon)#24MaStr wants to merge 3 commits into
MaStr wants to merge 3 commits into
Conversation
Adds project instructions describing the stable vs. development add-on split and the sync rules with upstream MaStr/batcontrol, plus a Claude skill that walks through porting upstream changes (options, schema, DOCS.md, CHANGELOG.md, translations, version bump). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CTyZuxYxCx3Ri9kYq6WqfV
Adds a skill that promotes a published upstream batcontrol release into the stable add-on (config/schema/DOCS sync, version pin, changelog) and opens the next devN cycle in batcontrol-development. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CTyZuxYxCx3Ri9kYq6WqfV
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing documentation for AI assistants in this Home Assistant add-on packaging repository, including a top-level repo guide and two Claude “skills” that document repeatable workflows for porting upstream changes and releasing the stable add-on.
Changes:
- Added
CLAUDE.mddescribing repository layout, stable vs. development add-on rules, and validation steps. - Added a
port-batcontrol-changeskill with a step-by-step checklist for syncing upstream configuration/doc changes into the add-on. - Added a
release-addonskill documenting the stable release promotion workflow and how to start the next dev cycle.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| CLAUDE.md | New repo-level contributor/assistant guidance and rules for syncing config/docs. |
| .claude/skills/port-batcontrol-change/SKILL.md | New documented procedure for porting upstream changes into add-on config/docs/changelog. |
| .claude/skills/release-addon/SKILL.md | New documented procedure for promoting an upstream release to stable and opening the next dev cycle. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+10
to
+19
| repository.yaml # HA add-on repository manifest (name, url, maintainer) | ||
| batcontrol/ # STABLE add-on ("Batcontrol-next") | ||
| batcontrol-development/ # DEVELOPMENT add-on ("Batcontrol-development") | ||
| config.yaml # Add-on manifest: name/version/slug + options: + schema: | ||
| Dockerfile # Image build; BUILD_VERSION is taken from config.yaml version | ||
| DOCS.md # User-facing parameter docs shown in the HA UI | ||
| CHANGELOG.md # Shown in the HA UI on update | ||
| translations/en.yaml # Names/descriptions of option groups in the HA config UI | ||
| build.yaml # Base images per architecture | ||
| .github/workflows/lint.yaml # frenck/action-addon-linter over every add-on dir |
Addresses Copilot review on the layout tree in CLAUDE.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CTyZuxYxCx3Ri9kYq6WqfV
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds AI-assistant/contributor documentation to the add-on repository:
CLAUDE.md: project instructions describing the repo layout, the stable vs. development add-on split (release wheel vs. upstreammainbuild), theoptions:/schema:sync rules with the upstream reference config, changelog/translations conventions, and validation steps..claude/skills/port-batcontrol-change/SKILL.md: step-by-step skill for porting a single upstream MaStr/batcontrol change into the add-on — diff againstbatcontrol_config_dummy.yaml, updateoptions:+schema:(with a type-mapping table), DOCS.md, CHANGELOG.md, translations, and the dev version bump..claude/skills/release-addon/SKILL.md: skill for promoting a published upstream release into the stable add-on (verify the release wheel exists, sync config/docs from development, pinversionto the release tag, write the release changelog section) and for opening the nextdevNcycle inbatcontrol-development/.No changes to any add-on manifest, Dockerfile, or shipped file — documentation only, so no version bump.
Companion PR in the upstream repo: MaStr/batcontrol#390.
🤖 Generated with Claude Code
https://claude.ai/code/session_01CTyZuxYxCx3Ri9kYq6WqfV
Generated by Claude Code