CONTRIBUTING.md

Headless Game Engine - Contributing

Instructions

This monorepo is bootstrapped with Turborepo.

(Optional) It is recommended to install turbo globally

npm install turbo --global

In the root directory:

Intall all packages

npm install

Build all packages

npm run build

Test all packages

npm run test

Clean - delete all generated files, turbo cache and node modules

npm run clean

Publishing to NPM

Login to npm account.

npm login

Adding changesets

Good practice to add one per package for cleaner changelogs.

npm run changeset

Follow the prompts in the CLI.

Press spacebar to select and enter to confirm.

Press enter without selecting anything to skip (eg. the major bumps).

Can continue editing the changelog summary later in the generated markdown file.

Commit after adding a changeset(s).

Versioning

npm run changeset:version

This consumes all changesets, and updates to the most appropriate semver version based on those changesets. It also writes changelog entries for each consumed changeset.

Commit after running this command and reviewing all the changes.

Can review what each package will publish to NPM with the following command. Run this in the root directory of the package to review.

npm publish --dry-run

Publishing

npm run changeset:publish

Immediately publishes the current commit to NPM.

Do not add commits between versioning and publishing as it assumes the versioning commit to be the publishing commit.

Git tags will be created. Remember to push the git tags.