Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 1.08 KB

Contributing

Developing

The tooling is Yarn, Lerna, Prettier and Eslint. To get started:

$ yarn install
$ yarn run lerna link

It's easiest to have Prettier format your changes in your editor on save: https://prettier.io/docs/en/editors.html

Building

$ yarn run build

Linting

$ yarn run lint

Testing

$ yarn test

Each package has unit tests using Jest. split.js uses Jasmine 2.6 for browser testing with IE8 support. Karma is the test runner for headless browsers. Recent versions of Chrome and Firefox support headless testing locally. By default, both browsers are tested. If you want to test with just one or the other, run:

$ yarn workspace split.js run test --browsers FirefoxHeadless

or

$ yarn workspace split.js run test --browsers ChromeHeadless

On the CI, SauceLabs provides cross-platform testing. Headless Firefox and Chrome are also tested via Docker container.