From b0af317eaab2d3eedf2a7918abe8d96bda89e335 Mon Sep 17 00:00:00 2001 From: Adrian Duke Date: Wed, 8 Apr 2026 19:05:02 +0100 Subject: [PATCH] hacking: Update docs with 'just' commands --- HACKING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/HACKING.md b/HACKING.md index a587c0c4..c3cb2f45 100644 --- a/HACKING.md +++ b/HACKING.md @@ -29,6 +29,16 @@ The repository is structured in *crates*, as follows: * `radicle-term`: A generic terminal library used by the Radicle CLI. * `radicle-tools`: Tools used to aid in the development of Radicle. +## Task runner + +We use [`just`](https://just.systems/) to manage project tasks such as linting, formatting, and installing git hooks. To see a list of all available commands, run: + + $ just + +If you are not using Nix, it is highly recommended to install the git hooks to automatically run checks before committing and pushing: + + $ just install-hooks + ## Running in debug mode To run the services or the CLI in debug mode, use `cargo run -p `.