Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

60 lines (38 loc) · 1.44 KB

Have a bug or a feature request?

Look in the issue tracker for your issue. If it isn't already there, feel free to create one.

Bugs should include steps to reproduce. If you can, please link to a branch with a failing test.

Want to contribute to development?

Feel free to take on issues in the issue tracker. If you don't know what to work on, issues are prioritized on the project board.

Then fork the repo and make a pull-request when you're ready! In-progress PRs are encouraged.

Directories

Development Guide

The following commands run in the root of the repo:

Prequisites

Install:

  • yarn 1.3.2
  • node v8.7.0

Install package dependencies:

yarn

Building and Testing

Build packages:

yarn build

To run all checks:

yarn check-all

To start a local development server for gallium.live:

yarn start

A useful shell one-liner that checks your code as it changes. Uses ag and entr:

ag -l | grep '.js' | entr -cdrs 'yarn flow && yarn test && yarn format'