Contributing Guide

Commits

Use conventional commits (https://www.conventionalcommits.org/). This enables automatic versioning and changelog creation when publishing.

Pull Requests

Thank you for your interest in this project. I respect your time and effort. Therefore, if for any reason you have doubts on the direction of feature or even whether it's in scope for the project, please open an issue first to get discussion started before doing any work. Otherwise, ensure you follow these items:

1. Create a feature branch - Pull requests based of your master branch will not be accepted.
2. Keep the repo's style - Don't forget to run the linter before committing.
3. Commit history - Let your commits tell a story. Do not squash everything into one commit. Preferably, each commit should build.
4. Focused and concise - Keep pull requests small and scoped to one feature.
5. Add unit tests - Pull Requests will not be accepted without relevant tests.
6. Add documentation - I understand that English is not everyone first language. I can provide some assistance with the docs, but please give it your best effort.

Development

Simply, pnpm install and pnpm build.

Here are the main scripts for the monorepo, but there may be more specialized scripts in each workspace.

build

Builds all workspaces in 'production' mode.

serve

Serves the docs workspace in 'production' mode.

dev

Serves the docs workspace in 'development' mode with HMR enabled.

test

Runs tests for all workspaces.

lint

Lints all workspaces.

clean

Cleans all workspaces.

Tests

Testing is provided by Vitest. In addition to the main test script, it may be useful to develop tests in watch mode.

pnpm test watch