docs: expand CLAUDE.md with commands, change checklist, and add-on sync notes#390
Open
MaStr wants to merge 3 commits into
Open
docs: expand CLAUDE.md with commands, change checklist, and add-on sync notes#390MaStr wants to merge 3 commits into
MaStr wants to merge 3 commits into
Conversation
…nc notes Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CTyZuxYxCx3Ri9kYq6WqfV
Documents the release flow (bump-my-version, Prepare Release workflow, tagging, Docker build trigger, next dev cycle, HA add-on promotion) as a Claude skill with confirmation gates before irreversible steps. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CTyZuxYxCx3Ri9kYq6WqfV
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the repository’s contributor-facing documentation by turning CLAUDE.md into a more complete “how to work on batcontrol” guide (commands, checklist, release notes) and by adding a dedicated .claude skill document for the release process.
Changes:
- Expanded
CLAUDE.mdwith commonuv/test/lint commands, a change checklist, and HA add-on sync notes. - Added a new
.claude/skills/release/SKILL.mddescribing the end-to-end release workflow (prepare-release, tagging, next dev bump, HA add-on promotion).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
CLAUDE.md |
Adds contributor commands/checklist and release guidance; contains a couple of doc accuracy issues to fix. |
.claude/skills/release/SKILL.md |
Introduces a “release” skill document describing the release procedure and workflows. |
Comment on lines
+12
to
+16
| uv venv --python 3.13 --allow-existing # setup only | ||
| uv pip install -e '.[test]' | ||
| uv run pytest tests/ -k <name> # single test / subset | ||
| uv run pylint src/batcontrol # target score >= 9.0 (10 if achievable) | ||
| uv run autopep8 --in-place <file> # PEP8 formatting |
pylint/autopep8 are not part of the test extras, install them alongside; the 15-min transform doc lives under docs/development/. 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.
Co-Authored-By: Claude Fable 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01CTyZuxYxCx3Ri9kYq6WqfV