Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 857 Bytes

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 857 Bytes

Contributing

Install

$ yarn

Build source

Build the publish Babel sources:

# One time build
$ yarn run build

# Watch
$ yarn run build-watch

Running the demo

Run the webpack-dev-server on http://localhost:8080

$ yarn start

Tests

Basics:

# Everything
$ yarn run check

# ... which really runs
$ yarn run lint
$ yarn run test

And E2E tests (you must be on node@8+):

$ yarn run test-e2e

Release

(Only for project administrators)

We use an npm version release workflow:

  1. Run npm version patch (or minor|major|ACTUAL_VERSION_NUMBER) which runs tests/lint, builds all files we need to publish, mutates package.json, and does all the requisite git stuff.
  2. Run npm publish and publish to npm if all is well.
  3. Run git push && git push --tags