Skip to content

chore: add CLAUDE.md, rewrite contributor guide, add PR CI [skip ci] - #343

Merged
donavanbecker merged 3 commits into
latestfrom
chore/claude-md-and-guide
Oct 24, 2026
Merged

donavanbecker merged 3 commits into
latestfrom
chore/claude-md-and-guide

Conversation

@donavanbecker

@donavanbecker donavanbecker commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

What

  • Rewrites .github/copilot-instructions.md to match the current code. It still described the pre-v4 layout (src/switchbot-ble.ts, src/device.ts, SwitchBotBLE/SwitchBotOpenAPI, "12 tests", async-mutex), none of which exist any more.
  • Documents how to port a pySwitchbot release, with a file-by-file map between the two codebases and the follow-up PRs for homebridge-switchbot and SwitchBotAPI-BLE.
  • Records the known DEVICE_MODEL_MAP drift from pySwitchbot (e.g. Meter Pro o vs 4) so it is fixed deliberately, in its own PR.
  • Adds PR CI (.github/workflows/ci.yml): build, test and lint on Node 22 and 24 for PRs to latest and beta-*. Until now PRs had no checks at all.
  • Documents the [skip ci] title convention for changes that don't affect the published package.
  • Adds CLAUDE.md, which imports the guide so Claude Code and Copilot share one source of truth.

Notes

  • No changes to the published package. Build, 316 tests and lint pass.
  • The title ends with [skip ci] so the squash merge to latest does not cut an empty release (same mechanism as chore(release): v5.0.0 [skip ci] #342). The new CI still runs on this PR.

https://claude.ai/code/session_01TYWa2RXoWsaUTWh76oNv8s


Generated by Claude Code

- Rewrite .github/copilot-instructions.md to match the current code. It
  described the pre-v4 layout (src/switchbot-ble.ts, src/device.ts,
  SwitchBotBLE/SwitchBotOpenAPI, "12 tests", async-mutex), none of which
  exist any more.
- Document how to port a pySwitchbot release, with a file-by-file map
  between the two codebases and the follow-up PRs for
  homebridge-switchbot and SwitchBotAPI-BLE.
- Record the known DEVICE_MODEL_MAP drift from pySwitchbot.
- Add CLAUDE.md, which imports the guide so Claude Code and Copilot share
  one source of truth.

No code changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TYWa2RXoWsaUTWh76oNv8s
Pull requests had no CI; checks only ran on pushes to beta branches.
Add a CI workflow for PRs to latest and beta-* on Node 22 and 24, and
document the [skip ci] title convention for docs/tooling-only PRs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TYWa2RXoWsaUTWh76oNv8s
@donavanbecker donavanbecker changed the title docs: add CLAUDE.md and rewrite the contributor guide for v5 chore: add CLAUDE.md, rewrite contributor guide, add PR CI [skip ci] Oct 24, 2026
The previous commit message quoted the skip-ci token, which made GitHub
skip CI for this branch. This empty commit lets the new workflow run.
It disappears when the PR is squash-merged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TYWa2RXoWsaUTWh76oNv8s
@donavanbecker
donavanbecker merged commit be8d63a into latest Oct 24, 2026
2 checks passed
@donavanbecker
donavanbecker deleted the chore/claude-md-and-guide branch October 24, 2026 10:58
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