Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

66 lines (42 loc) · 1.2 KB
Raw

Contributing

Contributions are always welcome, no matter how large or small!

We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.

Development workflow

Prerequisites:

  • pnpm
  • rust toolchain
  • rust target wasm32-unknown-unknown
  • wasm-bindgen

You can install wasm-bindgen with:

cargo install wasm-bindgen-cli

The wasm32-unknown-unknown target can be installed with:

rustup target add wasm32-unknown-unknown

To run the build you can run

pnpm install
pnpm build

Tests

To run the tests you can run

pnpm test

End-to-end tests

To run the end-to-end tests you can run

cd examples/client-simple-webpack
pnpm test:e2e

Versioning

Is managed via Changesets and the Github CI. This means every change should also include a changeset which can be created running:

npx changeset

You can bump a version running the version action here: https://github.com/serenity-kit/opaque/actions/workflows/release.yml

Publish

Is managed via the Github CI

You can publish running the publish action here: https://github.com/serenity-kit/opaque/actions/workflows/release.yml