Contributing

Development Setup

Requirements: Go 1.26.7 (exact — see go.mod), Nix (optional but recommended)

git clone https://github.com/LarsArtmann/samber-do-auditlog.git
cd samber-do-auditlog
go mod download

Nix DevShell

For the full toolchain (Go, templ, golangci-lint, govulncheck, actionlint):

nix develop

Building

go build ./...
go generate ./...   # regenerate templ

Testing

# Run all tests
go test ./...

# With race detector (CI uses this)
go test -race ./...

# Coverage gate (CI: >= 94% of non-example/cmd code)
sh scripts/coverage-gate.sh

Linting

Uses golangci-lint v2 with nearly every linter enabled:

golangci-lint config verify   # validate config
golangci-lint run             # full lint
go vet ./...                  # static analysis

Running the Example

DO_AUDITLOG_ENABLED=true go run ./example

The example demonstrates every major samber/do v2 feature with a ride-sharing domain model.

Code Style

• Table-driven tests with t.Parallel() for test isolation
• Functional options pattern for configuration
• Strong types over runtime checks
• Early returns over nested conditionals
• exhaustruct: all struct fields must be explicitly initialized (tests exempted)
• JSON tags use snake_case via tagliatelle

Pre-Commit Hook

git config core.hooksPath scripts/hooks

The hook runs: generate drift check, go vet, golangci-lint, go test -race.

CI

All pull requests must pass 7 parallel jobs:

1. test: go vet, go build, go test -race with coverage gate (>= 94%)
2. lint: golangci-lint config verify then golangci-lint v2.12.2
3. vulncheck: govulncheck pinned via go run golang.org/x/vuln/cmd/govulncheck@v1.7.0 ./...
4. mod-tidy: go mod tidy drift check (transport-flake tolerant)
5. stale-generation: committed-generated-files guard + go generate ./... diff check
6. actionlint: workflow lint
7. example-smoke: runs the 23-feature self-checking example

A weekly scheduled run (Mondays 05:00 UTC) sweeps for new advisories and rot between pushes.

Pull Requests

• Ensure all tests pass: go test -race ./...
• Ensure linting passes: golangci-lint run
• Add tests for new functionality
• Keep changes focused and atomic
• Update CHANGELOG.md under [Unreleased]