Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (28 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 1.79 KB

Contributing

See the "Contributing" section of the wasm-bindgen guide.

Justfile

This project includes a justfile as a convenient store of commonly used commands. The justfile is entirely optional - all tasks can still be run using their underlying commands directly. It simply provides shortcuts for script invocations you would otherwise need to remember or look up.

Available commands:

  • just clippy - Run clippy linting (accepts optional args)
  • just test - Run all tests

Run individual tests (all accept test names as args):

  • just test-wasm-bindgen - Run end to end Node.js tests (accepts optional args for test names)
  • just test-wasm-bindgen-futures - Run end to end Node.js futures tests (accepts optional args for test names)
  • just test-cli - Run CLI tests
  • just test-macro - Run macro tests
  • just test-macro-support - Run macro support tests
  • just test-ui - Run UI tests for macros

To inspect failed generated tests for just test-wasm-bindgen, set WASM_BINDGEN_KEEP_TEST_BUILD=1 to retain the temporary folder for test output.

Update fixtures:

  • just test-cli-overwrite - Run CLI tests overwriting reference tests
  • just test-ui-overwrite - Overwrite UI test outputs

Release Process

The release process for Wasm Bindgen typically consists of the following steps:

  • ./publish bump
  • Regenerate the reference tests (just test-cli-overwrite).
  • Check if the schema version must be bumped (did the schema hash in the shared crate change since the last release, without bumping the schema version?).
  • Bump the changelog.
  • Commit and publish as a PR.
  • Merge and wait for status checks to succeed.
  • Push a new tag, which then triggers the automated release process.