Contributing to the Pancake ecosystem 🥞

Thanks for taking the time to contribute ! You can start by reading our Contribution guidelines first.

Setup

Install the dependencies

yarn

This project uses Storybook. To start development run

yarn storybook

Don't forget to setup your IDE with eslint and prettier.

The whole project is built with TypeScript. Make sure you export only the types needed on the client. Prefer using interface over types.

The entry point is src/index.ts, you can find all the exports in this file.

components contains all the atomic and generic components of the UIkit.
widgets contains more complex components with business logic.
theme is where you can find all the styling configuration. It follows the System UI Theme Specification
hooks contains generic hooks.
utils contains internal utils functions. It's not meant to be exported.

Run tests with yarn test. When you create a component, don't forget to create a snapshot test.