Skip to content
This repository has been archived by the owner on Apr 15, 2023. It is now read-only.

Latest commit

 

History

History
21 lines (16 loc) · 1011 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (16 loc) · 1011 Bytes
Raw

Contributing

Instructions

These steps will guide you through contributing to this project:

  • Fork this repository
  • Install dependencies by running $ yarn
  • Implement your changes and tests
  • Ensure tests are passing and all changes have 100% coverage by running $ yarn test
  • Stage your changes and run $ yarn commit
  • Finally send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). Make sure all of your commits are atomic (one feature per commit).

Scripts

  • yarn start: Run the build in watch mode
  • yarn run test: Lint code, run test suite, and generate coverage
  • yarn run test:dev: Run test suite only
  • yarn run test:watch: Run test suite in interactive watch mode
  • yarn run build: Generate dist bundle, typings, and docs
  • yarn run lint: Lint code