Skip to content

Latest commit

 

History

History
28 lines (15 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

28 lines (15 loc) · 1.56 KB

How to Contribute

We’d love to accept your contributions to this project. There are just a few small guidelines you need to follow.

Project setup

  1. Fork and clone the repo
  2. yarn or npm install to install project's dependencies
  3. yarn start to start the demo app to see what affect your changes have

Development

There is a testing app available in __tests__/app - after installing its dependencies, run yarn develop in the __tests__/app directory. It will start a local development server that will autoupdate on any source code change.

There are few testing scenarios created in __tests__/app/src/pages or you can create your own by creating a new file in the pages directory.

Testing and linting

We use Puppeteer for screenshot testing, and because of (font) rendering inconsistencies between platforms, Docker image is used to keep the testing environment consistent.

Once Docker is installed and running locally, run yarn test to make sure tests and linter are passing before committing your changes.

To add a new screenshot test scenario, create a new file in __tests__/app/src/pages and it will be automatically picked up in the next test run, creating a new screenshot snapshot in the process.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. See GitHub Help for more information on using pull requests.