Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (22 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.15 KB
Raw

Contributing

Pull requests are welcome! For bigger changes, consider opening an issue first to discuss the approach.

Before opening a PR, run:

pnpm install
pnpm fix    # lint & format
pnpm check  # lint, tests, build and bundle size budgets

Browser compatibility tests (*.browser.test.ts) run in Chromium, Firefox and WebKit via Vitest browser mode. To run them locally:

pnpm exec playwright install chromium firefox webkit  # once
pnpm test:browser

If your change affects users, add an entry to the Unreleased section of packages/typed-binary/CHANGELOG.md.

Release workflow

  1. Bump version in both packages/typed-binary/package.json and packages/typed-binary/jsr.json, and rename the changelog's Unreleased section to that version. Commit it as ⬆️: vX.Y.Z.
  2. Create a GitHub release with a vX.Y.Z tag. Publishing it triggers the npm and JSR workflows. Versions containing alpha (e.g. 4.4.0-alpha.0) are published to npm under the alpha tag.