Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (31 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 1.27 KB

How to Contribute

Setup

Fork and clone this repository, then run

yarn install

Run tests:

yarn test

Code

This repository is a monorepo which means it contains multiple NPM packages. We use Yarn workspaces architecture to install dependencies and link local packages between each other, and lerna to run commands for one or more packages from the root directory.

Running yarn install in the repository's root directory will install the dependencies of all packages and link the packages that depend on each other.

Running yarn test will run all packages' tests. Run yarn test inside a package directory to test this package only.

Just edit the code like you always do. Be aware that we automatically lint and format code with eslint and prettier.

Share

  1. Fork the repository.
  2. Create a new branch from master.
  3. Do something awesome.
  4. Add / update tests.
  5. Update changelogs of all packages that you change. Use Next release as a version number.
  6. Push them and open a pull request.

More Information