Hi! I'm excited that you're interested in contributing to this project! Contributing should be enjoyable and productive for everyone, so please be kind to others and reach out if you have any questions or concerns (this project follows a Code of Conduct).
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.
The concept of Gatsby themes is rather new and best practices still need to be figured out. Therefore changes to themes need to evaluated in more detail (e.g. if they would be breaking). 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. Especially since this project is currently only maintained by me, LekoArts.
This repository uses Yarn Workspaces and Lerna to develop multiple packages together as a monorepo. Be sure to install Yarn before setting up the development environment.
Clone the repository:
git clone [email protected]:LekoArts/gatsby-themes.gitInstall 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-emilia" workspace with the example "emilia" like:
yarn workspace emilia developUnit tests are run with Jest, and are included where appropriate (mostly for utils/helper functions). Feel free to improve the code base with additional tests!
Running tests:
yarn testRunning tests in watch mode:
yarn test:watchMost of the themes' functionality is tested with Cypress as it allows real-world testing which is most important for me when developing themes. The tests are written in TypeScript, too, and hence need to be compiled before usage. Run the following script for development:
bash ./scripts/e2e-dev.sh "example-name"In the case of examples/emma the "example-name" would be "emma".
The script starts tsc in watch mode (for the files in cypress/e2e) and outputs them to cypress/e2e/build + starts start-server-and-test with Gatsby's development server and Cypress. Once the Cypress GUI opens select the fitting test (the others won't work, only the respective test + smoke.js!).
CircleCI will run the e2e-build.sh script — you can use it to run the tests headless.
You can skip the e2e tests if you use docs or www in your branch name, e.g. docs/improve-readme or www/add-new-entry.
When opening a pull request, please be sure to update any relevant documentation in the READMEs or write some additional Jest/Cypress tests to ensure functionality. Also include a high-level list of changes.