CONTRIBUTING.md

Contributing to hey-cli

Prerequisites

• Go (version in go.mod)
• golangci-lint v2+
• mise (optional, for toolchain management)

Install dev tools:

make tools

Build

make build

The binary is written to bin/hey.

Test

make test

Run with race detector:

make race-test

Lint

make lint

Check formatting:

make fmt-check

Full local CI gate

make check

This runs fmt-check, vet, lint, test, and tidy-check.

CLI surface compatibility

make check-surface-compat

Compares the current CLI surface against the previous tagged release to detect breaking changes.

PR workflow

1. Fork and create a feature branch from main.
2. Make your changes.
3. Run make check and ensure everything passes.
4. Open a pull request against main.