Hi! We're looking for some help, and we're excited that you're interested! We want contributing to this project to be enjoyable and productive for everyone. All contributions are welcome, including opening and commenting on issues and pull requests, adding or updating the docs, bug fixes, blog posts, and suggestions for new features. We follow a Code of Conduct, so please be kind to others and reach out if you have any questions or concerns.
Theme UI is still in an early stage and things will likely move quickly. The time to review a pull request depends on the complexity involved, so please be patient if a particular feature takes longer to review than others.
This repo uses pnpm workspaces to develop multiple packages together as a monorepo. Be sure to install pnpm before setting up the development environment.
Install dependencies and link local packages in the root directory:
pnpm iIn postinstall script running after dependencies install, Preconstruct
links source files to dist directories.
Depending on the part of the codebase you're working on, you'll want to run tests or docs development server.
The docs are using Gatsby. To start development server run:
pnpm run dev:docsChanges to libraries will immediately hot reload the docs.
Unit tests are run with Jest, and each package should include a test/
directory with unit tests for that package.
Running tests:
pnpm testRunning tests in watch mode:
pnpm test --watchYou can specify what tests to run by passing test path pattern as the first
positional argument and test name pattern after -t flag.
pnpm test core/test/react-jsx -t 'accepts sx prop'When opening a pull request, please be sure to update any relevant documentation
in the READMEs or in the packages/docs directory. Also include a high-level
list of changes in the CHANGELOG.md file at the top under the
## Unreleased heading.