Hey—thanks for your interest in contributing! We follow the Hack Club Code of Conduct, so please be kind and reach out if you have any questions or concerns.
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 whatever you’re looking for.
yarn workspace <name-of-package> <command>Where name of package is something like @hackclub/theme or @hackclub/meta (one of the packages
listed by yarn when you run the yarn workspaces info command)
Example:
yarn workspace @hackclub/meta prepareUnit tests are run with Jest, and each relevant package includes 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.
Doc adapted from Theme UI