First of all, thanks for your interest on contributing to this project 🙌🏻.
Before you start working on your proposal, please browse open issues and PRs to ensure anyone else is working on the same thing. If no one is doing it, then open an issue first requesting for comments and validations from the project maintainers.
- Fork and clone this repo.
- Run
yarn setupto install dependencies and run validations.
To run the web storybook, run yarn start:web, this will start typescript in watch mode for all packages and the storybook dev server.
To run the mobile app, run yarn native:start, this will start typescript in watch mode for all packages and the expo bundler.
To run the tests run yarn test or yarn test --watch to watch for changes. Please write some tests if you are changing anything 🙏🏻.
So you finished your new kick ass feature, life saving bugfix, confidence boost test or user engaging documentation. Now what?
First, ensure everything works by running yarn validate. Although this will be also validated on the CI system, it will anticipate any issue and avoid you further work to pass the CI.
Once you are sure there is no validation issues, go ahead and open a PR and wait for your awesome work to be included.