Skip to content

docs(readme): document just mutation and the Mutation testing job #338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
0x73746F66 merged 1 commit into from
Nov 13, 2026
Merged

docs(readme): document just mutation and the Mutation testing job #338

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Loading