Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 932 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 932 Bytes
Raw

Tips for contributors

Prepare your development environment

Just follow .devcontainer/Dockerfile to see what's needed.
Basically it's just nodejs >= v18 tsc and npm.
Qt5, cmake and ninja if you want to run the tests.

Running tests

sh test.sh

Or simply let GitHub actions run the tests for you.
See ci.yml for how we run the tests.

Install git-cliff

cargo install git-cliff

Releasing

(Replace 1.0.0 with actual version used)

  • Get a version compatible with semver, run git cliff --bump | head -n 5, replace NEW_VERSION
  • export NEW_VERSION=v1.0.0
  • Make sure Github Actions CI is green
  • npm version $NEW_VERSION # ignore the error
  • git cliff --tag $NEW_VERSION > Changelog
  • git add Changelog package.json package-lock.json && git commit -m "chore: bump version" && git tag -a ${NEW_VERSION} -m "${NEW_VERSION}" && git push && git push --tags && npm publish