Contributing

Set up the Liquidify monorepo and prepare a reviewable change.

Liquidify is a pnpm monorepo. Development currently requires Node.js 22 or newer and pnpm 9.15.9.

Local setup

git clone https://github.com/juanchavezcornejo/liquidify.git
cd liquidify
pnpm install
pnpm run setup

Start the website:

pnpm dev

Start the public component playground from its workspace package when working on stories. Keep component behavior, specifications, generated API data, documentation, and public stories aligned.

Before opening a pull request

Run the checks relevant to the changed surface:

pnpm run check --stage pre-commit
pnpm typecheck
pnpm build

For package changes, also run the package's tests and the repository's pre-push gate. Generated files must be regenerated through their owning script; do not hand-edit generated catalog or token artifacts.

Pull-request shape

Keep one change focused on one behavior or documentation concern.
Explain the user-visible effect and verification performed.
Add or update tests for behavioral changes.
Update public docs when an export, prop, default, callback, maturity, or SwiftUI mapping changes.
Use original or appropriately licensed example assets. Never commit private reference material.

Contributions are accepted under the repository's license. Review the root LICENSE before submitting code.