Docs

You can find our docs online.

Contributing

Follow the steps below to develop and contribute to the project.

Requirements

• Python >= 3.10
• Task >= 3.49.1
• uv >= 0.11.3

Set up

Build Huntsman (this also installs the Rust toolchain):

task build:rust

Adding files

Certain file types need to be added to our linting rules manually:

• YAML. If adding a YAML file (regardless of its extension), add it as an argument to the yamllint command in taskfiles/lint.yaml.

Linting

Before submitting a pull request, ensure you’ve run the linting commands below and either fixed any violations or suppressed the warning.

To run all linting checks:

task lint:check

To run all linting checks AND automatically fix any fixable issues:

task lint:fix

Running specific linters

The commands above run all linting checks, but for performance you may want to run a subset (e.g., if you only changed Rust files, you don't need to run the YAML linting checks) using one of the tasks in the table below.

Task	Description
lint:check-rust	Runs Rust formatting and Clippy checks.
lint:fix-rust	Formats Rust and applies Clippy fixes.
lint:toml-check	Runs the TOML linters and formatter.
lint:toml-fix	Runs the TOML linters and formatter and fixes some violations.
lint:yml-check	Runs the YAML linters.
lint:yml-fix	Runs the YAML linters.