CONTRIBUTING.md

Contribution guide

Contributions of any kind is welcome. There are several ways on how you can do it.
Keep in mind that this project has Code of Conduct.

Documentation

This section covers documenting part.

This project uses TypeDoc, which under the hood uses JSDoc.
You're free to:

• improve wording,
• fix typos,
• add some examples,
• and everything else that is related to improving the documentation.

Development

This section covers development part.

Setup

If you intend to setup this project locally, ensure you have right prerequisites from below table:

Prerequisites

You must have those tools installed.

Importance	Dependency	Version
❗required	Node.js	LTS
❗required	pnpm	Use corepack enable to automatically setup version

---

Step by step

1. Clone this repository.

2. Setup package manager for Node.js with corepack:

   corepack enable

3. Install project dependencies with pnpm:

   pnpm install

4. Take a look at the "scripts" in ../package.json to see if you can find what you need.

Code style

Most of the style issues will be caught by Biome.

Convention

1. snake_case for internal variable names and methods.
2. camelCase for public variable names and methods.

Pull Requests and commits

We use trunk based development flow.

tl;dr:

1. Pull Request(s) title is important. Needs to follow Conventional Commits specification.
2. We don't care about the commits messages inside the Pull Request(s) - during merge to the main branch(es), the entire history will be squashed into one.

Writing changelogs

This project uses changesets to manage changelogs.

Convention

For the consistency, use Conventional Commits specifications for the changesets description.