Contributing

Thanks for contributing to @putdotio/socket-client.

Setup

Install dependencies with Vite+ and wire the stock Git hooks:

vp install
vp config

Run the repo guardrail before opening or updating a pull request:

vp run verify

That command runs formatting, linting, package build, unit tests, and coverage using the same entrypoint CI relies on.

The repo keeps a websocket smoke test outside the default guardrail because it depends on a live external connection.

Run it manually when you want extra confidence in the real SockJS handshake path:

vp run test:integration

See Distribution for release automation, credentials, and npm publishing.

Prefer vp for day-to-day commands.
Put end-user package usage in Overview.
Keep contributor workflow changes in this file and security reporting guidance in Security.