Contributing

Feedback

You can leave feedback on any aspect of the library (features, documentation, etc.) in GitHub discussions.

Development

Personally, I use nix dev environment and mk, although pnpm@10 will suffice to perform any action.

Dev server

To start the playground, you need to execute the following commands

pnpm i
pnpm build
cd apps/playground2
pnpm run dev

If you are working on a theme then you can run it dev server, example:

cd packages/basic
pnpm run dev

Tests

You can run all tests from the root directory using the following command:

pnpm run test

Unfortunately, the library does not currently have good test coverage, so contributions with tests are extremely welcome.

Commit style

The commit message should be structured as follows:

[scope] <description>

Scopes:

• Each package is a separate scope (e.g. package skeleton3-theme - skeleton3 scope)
• The form package is divided into the following scopes:
  • lib
  • core
  • form
  • fields
  • templates
  • translations
• Scopes for changes affecting multiple packages of the same type
  • themes
  • validators
  • examples
• build

Changes

We use changesets, so don’t forget to add a changeset file using the pnpm changeset command.