Contributing

Setup

bun install

Submodules (for type generation) are pulled automatically. If you cloned without --recurse-submodules:

git submodule update --init

This repo uses Changesets to manage versioning and publishing of @gwigz/slua-types and @gwigz/slua-tstl-plugin.

Both packages are version-locked, they always share the same version number. When either package changes, both are bumped together.

When your PR includes changes to either published package, add a changeset:

bun changeset

This will prompt you to:

Select which packages changed (both will be bumped regardless due to the fixed config)
Choose a bump type (patch / minor / major)
Write a summary of the change

A markdown file is created in .changeset/, commit it with your PR.

Push or merge to main
The Release workflow detects pending changesets and opens a "Version Packages" PR
That PR updates package.json versions and CHANGELOG.md files
Merging the "Version Packages" PR triggers npm publish for both packages

Every PR and push to main runs the CI workflow: