CONTRIBUTING.md

Orbit Contribution Guide

Developing

To work on individual components

$ component=ComponentName npm run dev

Linting

To lint $ npm run lint

To install the pre-commit lint-hook $ npm run install:hooks

Style Autofix (eslint and stylelint automatically fix what they can) $ npm run lint:js -- --fix $ npm run lint:css -- --fix

Testing

Unit testing

We are using Karma to run unit-tests in Chrome (hopefully Safari and Firefox too in the future). To run unit-tests across all components, run: $ npm run test

To run tests for a particular component, run: $ component=YourComponent npm run test

Troubleshooting Karma

If your tests are timing out, go to System Preferenes > Security & Privacy on your Mac and make sure Accessibility control is enabled for Terminal