CONTRIBUTING.md

Prerequisites

• Node.js >= v7 must be installed.
• Yarn

Installation

• Run yarn in the module's root directory to install everything you need for development.
• Run yarn build in the root directory to build the modules.

Running Tests

• yarn test will run the tests once.
• yarn coverage will run the tests and produce a coverage report in coverage/.
• yarn test:watch will run the tests on every change.

Building

• Run yarn build in the root directory to build the modules. (Required before publishing)
• Run yarn build PACKAGE_NAME ANOTHER_PACKAGE_NAME to only build certain packages.
• Run yarn build:watch to build packages on every change.

Documentation Website Development

• Run above installation steps and then
• Run yarn start:site to run a development server of gatsby.
• Run yarn build:site to create a build of the assets for the documentation website.

Benchmarking

• yarn benchmark will run the benchmarks locally

• If you commit message includes #benchmark the benchmarks will run on the CI.

  • The results for branches in the emotion-js/emotion repo are here: https://travis-ci.org/emotion-js/emotion/branches