This guide provides instructions for setting up your development environment to contribute to the project.
Important
This document is a work in progress. Please open a blank issue if you would like to suggest improvements.
Before you begin, ensure you have the following tools installed on your system:
- Yarn is a fast, secure, and reliable package manager that helps you manage dependencies and share code with other developers.
- Yarn depends on Node.js, a asynchronous, event-driven JavaScript runtime designed to build scalable and efficient network applications.
- Commitizen is a tool that standardizes commit messages, automates version bumps, and generates changelogs, all to ensure consistent and readable commit history across projects.
You can use Homebrew to install these prerequisites and their dependencies on macOS, GNU/Linux, or Windows Subsystem for Linux (WSL) 2.
See also:
Trunk is a toolkit designed to automate code quality checks and accelerate pull request reviews, helping teams maintain high code standards without slowing down development.
Once you have Yarn installed, you can use it to install Trunk as a developer
dependency in package.json. This is handled for you by the Makefile.
Once installed, Trunk will then manage and install all the tools it uses.
You can instal Makefile
Commitizen is not included by Trunk, so it must be installed separately. It is required to run the pre-commit hooks and will also be used to manage versions, changelogs, etc.