From ca9a0db96b596e86e827c48d1546be9cb4d781b8 Mon Sep 17 00:00:00 2001 From: Christopher Langton Date: Fri, 13 Nov 2026 23:32:52 +1100 Subject: [PATCH] docs(readme): document just mutation and the Mutation testing job --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 00b60d6862..ea98b860cd 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,12 @@ just test `just test` runs `go test ./...`. Go 1.25 or newer is required (see `go.mod`). The `justfile` lists the other recipes, including the generators for docs and actions. +`just mutation` runs mutation testing with gremlins (pinned at v0.6.0): it changes the code of a +package (negated conditions, moved boundaries, swapped operators) and reruns that package's tests, +and fails when fewer than 80% of the mutants are caught. CI runs the default, `./internal/purl`, in +the "Mutation testing" job. Pass another package and threshold to survey it, for example +`just mutation ./internal/versions 0`. + ## Contributing Open an issue or a pull request at [github.com/Vulnetix/cli](https://github.com/Vulnetix/cli).