Contributing

Contribution Guide

Please make sure you have gone through the Code of Conduct and maintain a friendly environment.

Have a question?

Have a question on how to use the library or a suggestion to improve anything, create a discussion (opens in a new tab).

Found a bug?

Something not working as expected like types not matching the actual response or something wrong with docs, feel free to open an issue (opens in a new tab) detailing your problem.

How to contribute

pnpm is used as the package manager of choice. Installation instructions can be found here (opens in a new tab).

  1. Fork the repository and clone it locally on your machine.
  2. Install dependencies.
pnpm install
  1. Make your change and commit it to your forked repo.
  2. Make changes to the docs if necessary.

Docs are generated from TsDoc comments and kept in a separate docs folder, which is a Next.js/Nextra project. To view the docs in development mode:

pnpm generateDocs
cd docs
pnpm dev
  1. Create a new changeset documenting your changes and commit the file.
pnpm changeset
  1. Push your changes and you're ready to raise a PR!
  2. Tag me (opens in a new tab) as a reviewer and I'll get your PR reviewed and merged.

Please try to keep PRs limited to a single area of change and try not to club multiple changes in a single PR.

✨ Thanks for your contribution! It is highly appreciated.

ChangelogCode of Conduct