Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (30 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 1.95 KB

Contributing

Conventions for maintainers of @switchbot/openapi-cli.

Publishing a release

When cutting a new version (tag + GitHub Release):

  • Release title: the version number only (e.g. v2.5.1). No tagline, no descriptor like "Bug fixes and improvements".
  • Release body: keep it minimal. One or two sentences on what ships, a single line calling out any breaking change, and a link to the matching section in CHANGELOG.md for the full notes. Do not copy the CHANGELOG into the release body — the link is the source of truth and keeps the Releases page scannable.
  • No emojis, marketing copy, or "thank you" boilerplate.

Example body:

Round-2 + Round-3 smoke-test response — 24 bugs closed in one patch.

Breaking: --filter grammar unified across devices list, devices batch, events tail / mqtt-tail. See CHANGELOG §Changed (BREAKING) for migration.

Full notes: CHANGELOG.md

The CHANGELOG itself follows Keep a Changelog + SemVer, with a Changed (BREAKING) section whenever a release introduces a breaking change (even in a patch version).

Plugin hook strategies

The two plugin packages use different onInstall hook strategies — this is intentional:

Package Hook command Reason
packages/claude-code-plugin node ../bin/auth.js (relative path) Claude Code installs the full npm package; bin/ is always adjacent.
packages/codex-plugin switchbot-codex-auth (global binary) Codex may install only the plugins/switchbot/ sub-directory, placing it in ~/.codex/plugins/switchbot/. A relative path to bin/auth.js would escape the plugin directory and fail. Using the globally-installed binary works regardless of install layout.

When changing either hook, preserve this distinction. Do not "unify" them without first verifying that both installation layouts still resolve the hook correctly.