Contributing to amux

Development

git clone https://github.com/andyrewlee/amux.git
cd amux
./scripts/install-hooks.sh
make run

Run the local checks that mirror CI:

make devcheck

make devcheck is the required pre-PR gate: it runs vet, tests, and lint (including file-length checks).

golangci-lint is required locally. Install instructions: https://golangci-lint.run/welcome/install/

For style-only cleanup, run:

make fmt

Before opening larger PRs, also run strict ratcheted lint on changed code:

make lint-strict-new

Pull requests are CI-gated (automated). For local confidence before opening a PR:

always: make devcheck, make lint-strict-new
if touching internal/ui/, internal/vterm/, or cmd/amux-harness/: make harness-presets
if touching internal/tmux/, internal/e2e/, or internal/pty/: go test ./internal/tmux ./internal/e2e

Architecture references:

Versioning follows SemVer and tags are vX.Y.Z. Pushing a tag triggers the GitHub Actions release job.

Fast path:

git pull --ff-only
make release VERSION=v0.0.5

Manual steps:

make release-check
git tag -a v0.0.5 -m "v0.0.5"
git push origin v0.0.5

Notes:

make release runs release-check, creates an annotated tag, and pushes it. The worktree must be clean.
Release builds use the commit timestamp for main.date, which keeps the timestamp deterministic for a given commit. If you need strict bit-for-bit reproducibility, consider adding -trimpath and a stable build ID to the build flags.

The Homebrew tap lives in andyrewlee/homebrew-amux and auto-bumps the formula after a release.

After make release VERSION=vX.Y.Z, the tap workflow updates Formula/amux.rb (daily at 06:00 UTC).
To update immediately, run the Bump amux formula workflow in the tap repo.
Users upgrade with brew upgrade amux.