Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

75 lines (52 loc) · 1.56 KB

Contribution Guidelines

Repository

Code is organized in a git repository. It adheres to Semantic Versioning, makes use of Conventional Commits, and changes are recorded in file CHANGELOG.md according to the format Keep a Changelog.

Build

This project is implemented in Rust and uses just as a task runner. Install it with the following command.

cargo install just

All available tasks are defined inside file justfile, and their names and descriptions should be self-explanatory.

# List available tasks
just

# Check source code format
just check-format

# Check source code best practices
just lint

# Build the project
just build

# Build and run tests
just test

# Build the project in release mode
just build-release

# Flash the device in release mode and attach a serial monitor
just run-release

# Generate source code documentation
just build-documentation

# Audit dependencies
just audit

Two environment variables WIFI_SSID and WIFI_PASSWORD containing the credentials for connecting to WiFi must be defined and exported before building.

export WIFI_SSID="..."
export WIFI_PASSWORD="..."

# or, better

read WIFI_SSID
> [ENTER VALUE]
read -s WIFI_PASSWORD
> [ENTER VALUE]
export WIFI_SSID
export WIFI_PASSWORD

just build