All contributions are welcome, including opening and commenting on issues and pull requests, adding or updating the docs, bug fixes, and suggestions for new features.
This repository uses Yarn Workspaces and changesets to develop multiple packages together as a monorepo. Be sure to install Yarn before setting up the development environment.
Clone the repository:
git clone git@github.com:AdamQuadmon/gatsby-themes.git --depth=1Install the dependencies:
yarnAfter yarn has linked packages and installed the dependencies in the repo, you can inspect the locally available workspaces with:
yarn workspaces infoAs all themes are set up with a respective example page (to view the theme/changes), you could for example run the "gatsby-theme-lucifero" workspace with the example "lucifero" like:
yarn workspace lucifero developTests are not jet implemented
Unit tests can be run with Jest
Most of the themes' functionality can be tested with Cypress
When opening a pull request, please be sure to update any relevant documentation in the READMEs. Also include a high-level list of changes.
This repository uses changesets to do versioning. What that means for contributors is that you need to add a changeset by running yarn changeset which contains what packages should be bumped, their associated semver bump types, and some markdown which will be inserted into changelogs.