Skip to content

Contributing

Michael Dörer edited this page Oct 5, 2026 · 1 revision

Contributing

Working on the library itself (this repo):

npm install
npm test        # Jest
npm run lint    # Prettier check

There is no build step for the package. Test changes in a consumer project, e.g. created with npx srl init test-project from this repo or via npm link. test-project/ and test-data/ are gitignored scratch folders.

Git workflow

  • Branch from main as feature/*.
  • Merging and releasing are done by the maintainers.

Releases

Creating a GitHub release (tag X.Y.Z, no v prefix) triggers the npm-publish workflow. It writes the version into package.json, regenerates scripts/**/*.d.ts and publishes to npm.

Clone this wiki locally