gl-react/CONTRIBUTING.md

CONTRIBUTING

Contributions are always welcome, no matter how large or small.

Requirement

yarn

Setup

git clone https://github.com/gre/gl-react.git
yarn
yarn run build

Building

yarn run build

You must run this each time you modify one of the packages/ of the library. It rebuild the lib/ folders and will copy the packages into the projects.

Developing

yarn run watch

For a faster reload experience, this do like build but only for a specific file you modify.

Testing

yarn test

if you need to regenerate the snapshots:

yarn run test-rewrite-snapshots

typecheck:

yarn run flow

Finally, Please check that ALL examples of the cookbook are working correctly.

Cookbook

Run it

cd packages/cookbook
yarn start

Deploy (only gre can do this at the moment!)

yarn run deploy-cookbook

License

By contributing to gl-react, you agree that your contributions will be licensed under its MIT license.