Contributing

Prerequisites

• git, GitHub Desktop, GitKraken or any other Git client
• some editor: Visual Studio Code
• rustup
• mdBook: cargo install mdbook
• mdbook-mermaid: cargo install mdbook-mermaid

Editing

Open a terminal and start mdbook:

mdbook serve --open

This will open your browser, and you can start editing the files in src.

Committing

Before committing any changes, make sure to sign your commits using either SSH (recommended) or GPG commit signature verification. The master branch has branch protection rules in place and requires signed commits.