# Contributing

Thanks for contributing to `@putdotio/socket-client`.

## Setup

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

```bash
vp install
vp config
```

## Validation

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

```bash
vp run verify
```

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

## Optional Smoke Test

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:

```bash
vp run test:integration
```

## Release Publishing

See [Distribution](./docs/DISTRIBUTION.md) for release automation, credentials, and npm publishing.

## Development Notes

- Prefer `vp` for day-to-day commands.
- Put end-user package usage in [Overview](./README.md).
- Keep contributor workflow changes in this file and security reporting guidance in [Security](./SECURITY.md).

## Pull Requests

- Keep changes focused.
- Add or update tests when behavior changes.
- Update docs when package usage, validation, or release behavior changes.