Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 1.22 KB
Raw

Contributing

Technical overview

We use Bolt to manage our mono-repo. Please read their docs before proceeding.

  • The site can be found in site/.
  • All packages can be found in packages/.

Getting started

To get started, run bolt.

Tests

To run your tests in watch mode, run:

jest --watch

To narrow down the tests that are run, you can use the --testPathPattern option:

jest --watch --testPathPattern skatejs

The above would run only tests that have paths that match skatejs, for example.

Documentation / website

To document a package or work on the website, run bolt dev. This will start up a webpack-dev-server and you can dev as normal.

Other commands

Here are some other commands that you may need to run from time to time, for whatever reason:

  • bolt build builds all distributions.
  • bolt flow invokes the local flow-bin dependency.
  • bolt precommit runs the pre-commit hook.
  • bolt prepare prepares the packages for publishing.
  • bolt site compiles the website.
  • bolt test runs all tests for all packages once.
  • bolt test:js runs all the unit / integration tests.
  • bolt test:ts runs all of the TypeScript definition tests.