Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

jss/contributing.md

Go to file
 
 
Cannot retrieve contributors at this time
Contributing Want to contribute but got stuck? Prerequisites Installation Building Lint & Formatting & Typechecking Run tests IDEs
60 lines (39 sloc) 1.15 KB
Raw Blame
Open in GitHub Desktop

Contributing

Want to contribute but got stuck?

Please reach out on Discord

Prerequisites

To install the development dependencies, you will at least need Node 8 installed.

Installation

We use Yarn as our package manager. It will install all dev dependencies and the dependencies in the actual packages.

yarn

Building

For building all of the packages run:

yarn build

Lint & Formatting & Typechecking

To lint, format, and type check the project run the following commands:

yarn check:lint
yarn format
yarn check:ts

Run tests

Using karma (real browsers will get launched).

Notice: When you change the source files of packages, you will need to rebuild the project.

yarn test

IDEs

If you are using VS Code, you'll need to do 2 things to get Flow type support:

  1. Install the Flow Language Support extension.
  2. If necessary, update your local settings to disable JS file validation:
// <PROJECT_ROOT>/.vscode/settings.json
{
  "javascript.validate.enable": false
}