gl-react/CONTRIBUTING.md
Gaëtan Renaudeau 4600bcedd0 initial release
2016-12-02 10:55:17 +01:00

961 B
Executable File

CONTRIBUTING

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

Setup

git clone https://github.com/gre/gl-react.git
npm run install-all
npm run build

Building

npm 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.

Testing

npm test

if you need to regenerate the snapshots:

npm run test-rewrite-snapshots

typecheck:

npm run flow

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

Cookbook

Run it

cd cookbook
npm start

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

npm run deploy-cookbook

Clean up and reinstall everything

npm run clean-all
npm run install-all

License

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