This file contains information for contributing to this project.

Tooling

Foreman

This project uses Foreman to manage tooling.

After installing Foreman, install tooling by running:

foreman install

Additionally, this project uses pre-commit to check files before committing.

After installing pre-commit, install hooks by running:

pre-commit install

For compatibility on all platforms, this repo uses solely Unix (LF) line endings. Please configure your editor to follow this requirement.

To test, build the examples with:

remodel run build

To upload a example, you can use:

remodel run upload-example [example] [mainPlaceId] [migrationPlaceId]

Deploying is automatic, so pushing a new version tag should publish and release automatically.