Skip to content

Latest commit

 

History

History
39 lines (21 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

39 lines (21 loc) · 1.05 KB

On Sets Frontend

Contributing


Structure

This project was bootstrapped with Create React App, and is written in the React JavaScript framework.

The library also uses Flow (https://flow.org/) for static typing. All files marked with @flow must also staticly type check to be considered for a PR.

Setup

You need yarn installed on your machine.

Then, simply run:
yarn
to install all dependencies.

Launching the Development Server

run yarn start to launch the dev server

Testing

Testing is done with the Jest testing framework. There is currently much less test coverage in the front end library than the back end library.

Linting / Code Formatting

Code is formatted automatically with the prettier package, with prettier's defaults

The Atom editor has many plug-ins for using Flow and prettier.

https://atom.io/

Submitting

Make commits on a separate branch, then submit a pull request. After code review is complete, the feature will be merged into master.