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.

Development

This section covers development part.

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

You must have those tools installed.

Importance	Dependency	Version
❗required	Node.js	LTS
❗required	pnpm	Use `corepack enable` to automatically setup version
optional	typos	latest
optional	[lefthook]	latest

Clone this repository.
Setup the used Node.js package manager with corepack:
```
corepack enable
```
Install project dependencies with pnpm:
```
pnpm install
```
(optional) Install Git hooks with:
```
pnpm lefthook -g install
```
[!NOTE] This can save your time and project's CI & CD usage (even if it's free)
Take a look at the "scripts" in ./package.json to see if you can find what you need.

For the the usage convienience those scripts concurrently run related tasks:
- pnpm build
- pnpm dev <- this is for the development
If you intend to push changes... You can either rely on the optional step 4 to automatically do lint checks (related to the changed files) for you while attempting to create a commit message.
Otherwise use pnpm lint.
If lint checks has found any issue(s), see if you can automatically fix it by running pnpm fix.

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