Developer guide

Build instructions

You need to install the Rust toolchain if you have not already.

Ubuntu

sudo apt update
sudo apt install git build-essential pkg-config libssl-dev
git clone https://github.com/Andriamanitra/coctus
cd coctus
cargo build

Others

Please contribute to the Wiki by adding instructions for other distros and operating systems!

Tools

Just

We use just as a command runner for completing common tasks. You can read the justfile to see all of the available recipes (or run just --list after you have installed just). You don't need to use just to contribute but it can definitely save you some typing.

Rustfmt

We use rustfmt is for formatting code. You should use the nightly version (cargo +nightly fmt or just format) to ensure compatibility with the formatting rules (rustfmt.toml) that are used in Github Actions.

Clippy

clippy is an awesome linter that can give you really nice suggestions on how to improve code.