CONTRIBUTING.md

Contribution guide

Local setup

NPM must be installed (ref. Download Node.js):

node -v
npm -v

Task (taskfile.dev) is used to simplify the commands and unify with the CI/CD pipelines:

npm install -g @go-task/cli

Python3 must be installed with pip and venv:

python --version
sudo apt install python3-pip
sudo apt install python3-venv

Create a virtual environment for running Python:

python3 -m venv .venv
source .venv/bin/activate

Packages and binaries are required:

task setup

Code checks

Lint the code with:

task lint

Frameworks / libraries

Presentations are build with:

• Marp
• Slidev

Documentation

Presentation powered by MkDocs.

Start a local web server:

task docs:serve

Open the documentation on 127.0.0.1:8000.

MkDocs configuration is read from mkdocs.yml.