Contributing

September 28, 2022 ยท View on GitHub

  1. Fork it
  2. Install dependencies (pnpm i --frozen-lockfile)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'Added some feature')
  5. Test your changes (pnpm test)
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

Testing

We use Jest to write tests. Run our test suite with this command:

pnpm test

Code Style

We use Prettier and tslint to maintain code style and best practices. Please make sure your PR adheres to the guides by running:

pnpm format

and

pnpm lint