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 Yarn Workspaces and Lerna to develop multiple packages together as a monorepo. Be sure to install Yarn before setting up the development environment.
Install dependencies and link local packages in the root directory:
yarnAfter yarn has linked packages and installed dependences in the repo you can run the docs or an example site in the workspace with this command:
yarn start <name-of-package>Where name of package is something like docs or gatsby-theme-ui-example (one of the packages
listed by yarn when you run the yarn workspaces info command)
Unit tests are run with Jest, and each package should include a test/ directory with unit tests for that package.
Running tests:
yarn testRunning tests in watch mode:
yarn test --watchWhen 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.