CONTRIBUTING.md

Contribution Guide

Cheat sheet

# build
cargo build

# run a local version of alt
cargo run ...

# test
cargo test

# format
cargo fmt

# lint
cargo clippy

Setup

This project is built with rust. You'll need to have rust installed. See: https://www.rust-lang.org/tools/install

Nix

If you have nix, you can leverage an already provided development environment. Simply run nix develop. Note that this requires Nix flakes to be enabled.

Snapshot tests

Some of the tests in this projects are snapshot based. Instead of asserting on hard coded values, these tests use previously stored snapshots to ensure that certain important values don't change.

These tests are built using the insta crate. You don't need any special tools to run these tests.

If you need to change these tests or break them and need to change them. Please see https://insta.rs/docs/quickstart/ for a quick guide on how to use them. You'll mostly likely want to install the cargo-insta CLI which helps with managing snapshots.