Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (37 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 1.91 KB
Raw

Contributing

Development

quien is a standard Go module:

go build ./...
go test ./...
gofmt -l .                # must report nothing
golangci-lint run ./...   # CI uses the latest release

CI also enforces the modernize analyzer:

go run golang.org/x/tools/go/analysis/passes/modernize/cmd/modernize@latest ./...

Bumping dependencies

After any change to go.mod/go.sum, the Nix flake's vendorHash is stale and nix build will fail with a hash mismatch. nix-update fixes it automatically at release time, but to keep main buildable you can recompute it now:

# set vendorHash in flake.nix to a fake value, then build to learn the real one:
nix build .#default   # prints "got: sha256-…"; paste that into flake.nix
nix build .#default   # confirm it succeeds

Bumping the Go toolchain

The Go version lives in two coupled places that must move together:

  1. The go directive in go.mod.
  2. The flake's nixpkgs input in flake.nix, which supplies the Go compiler used by nix build. It is pinned to a stable channel (e.g. nixos-26.05).

nix-update does not touch the nixpkgs input, so the toolchain only moves when you bump it by hand:

  1. Check which channel actually ships the Go version you want — a stable release branch sometimes carries a newer patch than nixpkgs-unstable: 
    nix eval --raw github:NixOS/nixpkgs/nixos-26.05#go.version
  2. Update the directive (go mod edit -go=1.26.4) and, if needed, point inputs.nixpkgs.url at the channel that has it.
  3. Re-lock and recompute the vendor hash (see Bumping dependencies above): 
    nix flake update
nix build .#default
  4. Verify: go build ./... && go test ./... && nix build .#default.

If go.mod requires a newer Go than the pinned nixpkgs provides, nix build fails because the sandbox can't download a toolchain — that's the symptom of the two having drifted apart.