Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 1.15 KB

Contributing

New features and bugfixes are always welcome! In order to contribute to this project, follow a few easy steps:

  1. Fork this repository, clone it on your machine and run npm install
  2. Create a topic branch my-awesome-feature and commit to it
  3. Run npm run test and npm run build and verify that they complete without errors
  4. Push my-awesome-feature branch to GitHub and open a pull request

Quickstart

# (optional) - use the same version of node as other developers
nvm use
# install the dependencies and git hooks
npm install
# this bootstraps the monorepo
npm run build

Building

To build/compile the code:

npm run build

To rebuild when code changes (preferred method):

npm run build:watch

Testing

To run all tests and perform static linting:

npm run test

To automatically rerun tests when code changes:

npm run test:watch

To run tests in debug mode:

npm run test:debug