Files
prompts/prompts/REPO_POLICIES.md
sneak dcf75f6c72
All checks were successful
check / check (push) Successful in 22s
Close three gaps between the containerised-lint rule and its first adopters
The rule landed in 12e8db8 is right; these are the three places where the
canonical text and the repos implementing it can diverge without either
side looking wrong.

1. `.dockerignore` excluding the agent scratch directory is now stated as a
   correctness precondition of containerised linting rather than a
   context-size measure. `Dockerfile.lint` lints whatever `COPY . .` copies,
   and language toolchains discover files by walking the tree instead of
   reading `.gitignore`, so a nested worktree in the context puts the
   foreign-tree false reds back inside the container — in the convincing
   form, where the findings are real but belong to another checkout.
   sneak/quak measured the same discovery mechanism taking a test count
   from 210 to 1050.

2. The cache-bust build arg is fixed at `CHECK_EPOCH` in `Dockerfile.lint`
   as well as in `Dockerfile`. A per-file name is invisible to the grep that
   proves every build is busted, which makes a renamed guard and a missing
   guard read identically. sneak/quak's lint file currently names it
   `LINT_EPOCH`.

3. The formatting check must run in exactly one of the two images, and
   either placement is allowed. Splitting lint out of the `Dockerfile` is
   precisely the moment `fmt-check` gets dropped from both, and running the
   formatter beside the linters is the better shape wherever it is the same
   pinned dependency — it takes the last host toolchain off the checked
   path for the reason the linter came off it.

Both checklists carry the matching items, since a repo that satisfies the
policy prose but not the checklist is the drift this is meant to stop.

Refs #40
2026-08-10 12:59:44 +00:00

55 KiB

title, last_modified
title last_modified
Repository Policies 2026-08-10

This document covers repository structure, tooling, and workflow standards. Code style conventions are in separate documents:


  • Cross-project documentation (such as this file) must include last_modified: YYYY-MM-DD in the YAML front matter so it can be kept in sync with the authoritative source as policies evolve.

  • ALL external references must be pinned by cryptographic hash. This includes Docker base images, Go modules, npm packages, GitHub Actions, and anything else fetched from a remote source. Version tags (@v4, @latest, :3.21, etc.) are server-mutable and therefore remote code execution vulnerabilities. The ONLY acceptable way to reference an external dependency is by its content hash (Docker @sha256:..., Go module hash in go.sum, npm integrity hash in lockfile, GitHub Actions @<commit-sha>). No exceptions. This also means never curl | bash to install tools like pyenv, nvm, rustup, etc. Instead, download a specific release archive from GitHub, verify its hash (hardcoded in the Dockerfile or script), and only then install. Unverified install scripts are arbitrary remote code execution. This is the single most important rule in this document. Double-check every external reference in every file before committing. There are zero exceptions to this rule.

  • Every repo with software must have a root Makefile with these targets: make bootstrap, make setup, make test, make lint, make fmt (writes), make fmt-check (read-only), make check (runs test, lint, fmt-check), make docker, and make hooks (installs pre-commit hook). A model Makefile is at https://git.eeqj.de/sneak/prompts/raw/branch/main/Makefile.

  • Repos follow the Scripts to Rule Them All pattern: the implementation of each Makefile target lives in an executable script in script/ (script/bootstrap, script/setup, script/test, script/lint, script/fmt, script/fmt-check, script/check, script/docker), and the Makefile targets are thin shims that call them. The scripts must be POSIX sh (#!/bin/sh, set -eu, no bashisms) so they run in minimal containers (e.g. alpine images have no bash); locate the repo root with $(cd "$(dirname "$0")/.." && pwd -P) and cd there before acting. From the standard's canonical set we use bootstrap, setup (make the repo ready for development after a fresh clone: runs bootstrap, then install-precommit, plus any repo-specific initialization), test, and cibuild. script/bootstrap installs all dependencies idempotently and assumes nothing is present: base tools come from nix, apt, brew, or apk (detected in that order; apt runs noninteractive). For node it uses the installed node if present; otherwise it installs a PINNED node version via nvm, first installing nvm itself if missing — from a hash-verified GitHub release archive (never curl | sh), with bash installed as an explicit prerequisite since nvm requires bash. yarn is then pinned via corepack prepare yarn@<version> --activate. Never install "latest" or "lts"; always exact versions. script/cibuild runs the CI build: it changes to the repo root, runs script/lint first for fail-fast feedback (that is itself a container build — see the containerised-lint rule below), and then runs docker build --build-arg CHECK_EPOCH="$epoch" --build-arg VERSION="$version" ., where epoch is a per-invocation nonce (see the CHECK_EPOCH rule below) and version is computed on the host because .git is not in the build context (see the git-describe rule below); the Gitea workflow calls it. Four further scripts are our own extensions to the standard: script/check runs script/test, script/lint, and script/fmt-check; script/precommit is what the git pre-commit hook runs, and it calls script/check; script/install-precommit installs the git pre-commit hook (the make hooks target shims to it); and script/projectname (literally that filename) simply outputs the project's name. Scripts that need the name call script/projectname — e.g. script/docker assembles its image tag from it — so those scripts stay byte-identical across all repos. Repo-type-specific pre-commit extras (e.g. go mod tidy verification in Go repos) belong in script/precommit, not in the hook itself. Model scripts are at https://git.eeqj.de/sneak/prompts/raw/branch/main/script/<name>. The README must document the provided scripts in an Entrypoints section (see the README requirements below).

  • Always use Makefile targets (make fmt, make test, make lint, etc.) instead of invoking the underlying tools directly. The Makefile is the single source of truth for how these operations are run.

  • The Makefile is authoritative documentation for how the repo is used. Beyond the required targets above, it should have targets for every common operation: running a local development server (make run, make dev), re-initializing or migrating the database (make db-reset, make migrate), building artifacts (make build), generating code, seeding data, or anything else a developer would do regularly. If someone checks out the repo and types make<tab>, they should see every meaningful operation available. A new contributor should be able to understand the entire development workflow by reading the Makefile.

  • Every repo should have a Dockerfile. It must run the repo's checks as build steps so the build fails if the branch is not green — which requires ARG CHECK_EPOCH and its guard in every stage containing a check-running RUN, per the CHECK_EPOCH rule below. Without them a Dockerfile satisfies this criterion while its check layers are served from cache, so the build cannot fail on a branch that is not green.

    It runs the individual non-lint checks — script/test and script/fmt-check — and never make check. script/lint is itself a docker build (of Dockerfile.lint, per the containerised-lint rule below), so a RUN make check in this file attempts a docker build inside a build step, where there is no daemon. Lint is not skipped by this: it runs in its own container, and script/cibuild runs it first. Put a comment to that effect directly above those RUN lines, because make check is what the next person will reach for. Of the two, only script/test is fixed here: a repo may run its formatter in Dockerfile.lint beside the linters instead, and some should — see the containerised-lint rule below. It must then run in that file and not in this one, and never in neither.

    For non-server repos, the Dockerfile should bring up a development environment and run those checks. For server repos, they should run as an early build stage before the final image is assembled. Dockerfiles install development prerequisites by running script/bootstrap rather than duplicating installs inline; COPY script/ and the dependency manifests (package.json + yarn.lock, go.mod + go.sum, etc.) before running it so the bootstrap layer stays cached until dependencies change.

  • Every check-running RUN must be cache-busted with CHECK_EPOCH. Docker invalidates a COPY layer only when the copied content changes, so on an unchanged tree the check layer is served from cache, the suite never runs, and the build still exits 0. A sub-second docker build reporting success is a cache hit, not a result. This applies to every file that runs checks in a build step, which since linting moved into its own container means Dockerfile and Dockerfile.lint both — a Dockerfile.lint without the cache-bust is a lint that never ran, reported as a pass. The canonical form, in every stage containing a check-running RUN, placed after the dependency-install layer so that layer stays cached:

    ARG CHECK_EPOCH
    RUN [ -n "$CHECK_EPOCH" ] || exit 1
    RUN echo "check epoch: ${CHECK_EPOCH}" && <the check command>
    

    and in script/lint, script/cibuild and script/docker:

    epoch="$(date +%s%N)$$"
    version="$(git describe --tags --always --dirty 2>/dev/null || true)"
    [ -n "$version" ] || version="unknown"
    docker build \
        --build-arg CHECK_EPOCH="$epoch" \
        --build-arg VERSION="$version" \
        .
    

    The VERSION lines are there for a different reason, covered by the git-describe rule below; they are shown here so the two rules do not each document half a command. script/lint passes only CHECK_EPOCH, since no version is embedded in a lint image. All four CHECK_EPOCH elements are load-bearing; none is optional, and each guards a failure mode that otherwise fails green:

    • ARG is stage-scoped, so a single declaration leaves the other check stages frozen while the fix reviews as complete. Declare it in every stage that runs checks, immediately above the first such RUN.
    • Expand the value into the command. This makes the cache miss contractual rather than dependent on BuildKit's handling of an unreferenced ARG, and it puts the epoch in the build log. The guard is itself value-keyed, for the same reason: it references $CHECK_EPOCH, so BuildKit renders the epoch into that layer's description (rendered as RUN [ -n "<epoch>" ] || exit 1) and re-runs it whenever the value changes. Each stage therefore has two independent invalidation points, and the guard always precedes the check RUN. Keep both: the expansion is defence in depth, and it is what makes the epoch visible in the build output.
    • The [ -n ... ] guard is required: an unset ARG is empty, and empty is a stable cache key, so without it a bare docker build . still produces the false green. Failed steps are never cached, so the guard fails on every such invocation, loudly. A bare docker build . failing is by design.
    • Assign epoch= on its own line, never inline in the --build-arg argument: a failing command substitution inside an argument does not trip set -e, so the inline form silently degrades to an empty constant. The $$ suffix is required because busybox date drops %N and exits 0, so on an alpine host the epoch would degrade to second granularity and concurrent invocations would collide.

    This invalidates the check layers and everything after them while leaving go mod download, script/bootstrap, and the pinned toolchain install cached, so it does not push against the five-minute Docker build ceiling. Blanket --no-cache is not an acceptable substitute, on Dockerfile or on Dockerfile.lint: it re-runs go mod download / yarn install on every invocation, which makes linting network-dependent and pushes a lint that should take seconds toward the build ceiling. Never reach for docker builder prune to achieve the same end — the build cache is shared with every other build on the host, including other people's.

  • Every lint run happens in a container, and script/lint is that container build. The linter is never installed on the host and never invoked there. Every repo carries a Dockerfile.lint next to its Dockerfile; the linter runs as a build step, so a successful build is a clean lint. Building rather than bind-mounting is deliberate: it is what makes the pattern work unchanged where the docker daemon is remote and bind mounts are impossible. Docker is assumed available in every environment. Discarding the linter's cache on every run is the point of this rule, not a cost it pays.

    This closes a family of defects, every one of them an artefact of running the linter on a shared host, and every one of them observed rather than hypothesised:

    • A confirmed false green. An implementer reported 0 issues on a branch that was genuinely red with a goconst finding. golangci-lint keys cached results on file content, not location, so a second checkout of the same commit holds byte-identical files and serves its result. Note what content-keying implies: moving agents from worktrees into their own clones does not help, because two clones are byte-identical exactly as two worktrees were. It removes the foreign-path symptom and leaves the mechanism live, which makes the defect quieter rather than rarer.
    • False reds, repeatedly: findings reported against ../wt82-lint/..., against another agent's checkout, and against a worktree that had already been deleted; in one case 399 issues returned to a clean clone that genuinely lints 0.
    • Lock contention that cannot be distinguished from findings. golangci-lint flocks $TMPDIR/golangci-lint.lock (pkg/commands/run.go, acquireFileLock()) — host-global, keyed on the temp directory, entirely independent of GOLANGCI_LINT_CACHE, with a 5-second acquire timeout, so it fails precisely when the host is busiest. On failure it prints parallel golangci-lint is running, analyzes nothing, and exits non-zero. Proven not fixed by per-cache isolation: two concurrent runs with entirely separate cache directories still collided.
    • Version skew. A host linter differing from the pinned one, with the container surfacing thirteen findings the host missed on one repo, and a local make check green against a make docker that rejected the same commit with six goconst findings.

    A container per run has its own cache, its own TMPDIR and therefore its own lock, and a binary pinned by digest, so none of the above is reachable. That is also why the per-checkout GOLANGCI_LINT_CACHE/TMPDIR wrapper that used to be canonical here is gone rather than kept alongside this: its entire subject was making a host run trustworthy, and there are no host runs. Consuming repos delete it when they adopt this; see the adoption list at the end of this rule.

    The canonical Dockerfile.lint for a Go repo:

    # Lint-only image. `script/lint` builds this file and nothing else: the
    # linter runs as a build step, so a successful build IS a clean lint.
    #
    # The linter is invoked directly below rather than through `make lint`.
    # That is not a style choice: `script/lint` IS this build, so calling it
    # from inside would recurse into a docker build with no daemon.
    #
    # golangci/golangci-lint:v2.12.2 (Debian-based), 2026-08-07
    FROM golangci/golangci-lint@sha256:5cceeef04e53efe1470638d4b4b4f5ceefd574955ab3941b2d9a68a8c9ad5240
    
    WORKDIR /src
    
    # Dependency layer first, and deliberately above the ARG below, so it
    # stays cached and only the lint steps re-run on every invocation.
    COPY go.mod go.sum ./
    RUN go mod download
    
    COPY . .
    
    ARG CHECK_EPOCH
    RUN [ -n "$CHECK_EPOCH" ] || exit 1
    RUN echo "lint epoch: ${CHECK_EPOCH}" && \
        golangci-lint config verify --config .golangci.yml
    RUN golangci-lint run --config .golangci.yml ./...
    

    and the canonical script/lint, identical in every repo:

    #!/bin/sh
    # script/lint: run the linter. The linter is never installed on the host
    # and never invoked there — it runs in a container, one way, everywhere,
    # so a run cannot inherit another checkout's cache, another process's
    # lock, or a host toolchain that differs from the pinned one.
    set -eu
    
    ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
    
    main() {
        cd "$ROOT"
        # Own line: a failing command substitution inside an argument does
        # not trip `set -e`, and `$$` is required because busybox `date`
        # drops %N without erroring. Without a fresh nonce the lint layer is
        # served from cache and this script exits 0 having linted nothing.
        epoch="$(date +%s%N)$$"
        docker build \
            --build-arg CHECK_EPOCH="$epoch" \
            -f Dockerfile.lint \
            .
    }
    
    main "$@"
    

    Load-bearing properties:

    • CHECK_EPOCH, not --no-cache. docker build -f Dockerfile.lint . on an unchanged tree returns a sub-second cached success having linted nothing — the same false green the CHECK_EPOCH rule above exists to close, arriving through a new file. The ARG goes after the dependency layer so go mod download / yarn install stay cached and only the lint steps re-run. Blanket --no-cache also busts the dependency layer, which makes every lint network-dependent.
    • Non-Go repos get the same pattern around their own lintereslint, ruff, prettier, shellcheck — because the ruling is every lint run, not every Go lint run. Only the base image and the lint commands change; the WORKDIR, dependency layer, ARG CHECK_EPOCH, guard and expanded-value RUN are identical. A JS or docs repo bases on its pinned node image, runs script/bootstrap as the dependency layer, and lints with the linter from node_modules, which is also how it gets the version pinned in package.json rather than whatever is on the host.
    • The lint container lints whatever is in the build context, so .dockerignore is part of this rule and not merely hygiene. COPY . . copies an agent scratch worktree — an entire second checkout of the repo — into the lint image unless .dockerignore excludes it, and language toolchains discover files by walking the tree rather than by reading .gitignore, so ./..., eslint . and prettier --check . all descend into it. sneak/quak measured this on the same discovery mechanism in its test runner: a nested .claude/ worktree took the discovered test count from 210 to 1050 (sneak/quak#30). Left in the context it re-creates inside the container the foreign-tree false reds that moving lint into a container was adopted to end, and it does so in the convincing form — the findings are real, they simply belong to another checkout. See the .dockerignore rules below, and verify by enumerating the image rather than by reading the patterns.
    • The build arg is named CHECK_EPOCH in Dockerfile.lint too, not LINT_EPOCH or any other per-file name, and script/lint passes it under that name. Both files guard the same failure under the same contract, and the single name is what lets a reviewer grep a repo for CHECK_EPOCH and see every cache-bust it has. Rename it in one file and that grep silently misses it, so a renamed guard and an absent guard read identically without opening both Dockerfiles.
    • The formatting check runs in exactly one of the two images, and either one is allowed. The canonical Dockerfile above runs script/fmt-check because that is where the non-lint checks live. A repo may instead run its formatter in Dockerfile.lint beside the linters, which is the better shape wherever the formatter is the same pinned dependency as the linter (prettier out of node_modules, say), because it takes the last host toolchain off the checked path for the same reason the linter came off it. What is not allowed is running it in neither image, or in both. Whichever image runs it carries the epoch guard, and script/check still runs all three targets on the developer's side either way.
    • Keep golangci-lint config verify, and it costs no network. The two commands catch disjoint classes of defect, measured under the pinned v2.12.2 against a config carrying one planted defect at a time: a bogus top-level key and a bogus key nested under linters.settings.lll both pass golangci-lint run with exit 0 and 0 issues while config verify exits 3 and names the key; an invalid value type fails both; an unknown linter name fails run and passes config verify. So run alone silently ignores an unknown key, which is exactly the mode where a threshold reads as configured and is not applied. The earlier caution that config verify resolves its JSON schema over a live HTTPS fetch does not hold for this pinned version: every case above was re-run under docker run --network none and produced byte-identical diagnostics and exit statuses, in a container where getent hosts golangci-lint.run exits 2. The schema is embedded in the pinned binary. Re-run that control when bumping the pin rather than treating the result as permanent.
    • No repo installs a linter on the host, in script/bootstrap or anywhere else. A host install is now dead weight whose only remaining effect is to reintroduce the version skew above.
    • script/check still runs test, lint and fmt-check, so a developer and the pre-commit hook get all three. It therefore requires a docker daemon, and it must never be invoked from inside a build stage — see the Dockerfile rule above.
    • If the project uses //go:embed directives referencing build artifacts (e.g. a web frontend compiled elsewhere), Dockerfile.lint must create placeholder files so the directives resolve: RUN mkdir -p web/dist && touch web/dist/index.html. It must not depend on the real build output; it exists to fail fast.
    • If linting requires CGO or system libraries (e.g. vips-dev), install them in Dockerfile.lint.

    What a consuming repo does to adopt this, in order: add Dockerfile.lint; replace script/lint with the build above; delete the lint stage from its Dockerfile along with the COPY --from=lint ... /dev/null ordering line; change that Dockerfile's RUN make check to script/test and script/fmt-check with the comment explaining why; add script/lint as the first step of script/cibuild; delete any golangci-lint install from script/bootstrap; and delete the .lint-cache/ entries from .gitignore and .dockerignore together with the per-checkout cache/lock wrapper they served.

    The separate lint stage is superseded by this and must not survive alongside it. It ran make lint, which is now a docker build, so keeping it is not a stylistic preference but a recursion. Its purpose — fail-fast feedback before the slow build — is served by script/cibuild running script/lint first, and its COPY --from=lint /src/go.sum /dev/null ordering trick, along with the warm-cache re-proof that trick required, is no longer needed because the ordering is now sequential in the shell.

  • The canonical Go repo Dockerfile, which builds and tests but does not lint:

    # Build stage
    # golang:1.x-alpine, YYYY-MM-DD
    FROM golang@sha256:... AS builder
    WORKDIR /src
    COPY go.mod go.sum ./
    RUN go mod download
    COPY . .
    
    ARG CHECK_EPOCH
    RUN [ -n "$CHECK_EPOCH" ] || exit 1
    
    # The individual non-lint checks, NOT `make check`: script/lint is a
    # docker build (Dockerfile.lint), so `make check` here would nest a
    # build inside a build step, where there is no daemon. Lint is not
    # skipped — script/cibuild runs it first, in its own container.
    RUN echo "check epoch: ${CHECK_EPOCH}" && make fmt-check
    RUN make test
    
    # VERSION comes from the host via --build-arg; see the git-describe rule
    # below. Never run `git describe` here: .dockerignore excludes .git, so
    # it yields an empty version without failing the build.
    ARG VERSION=dev
    RUN CGO_ENABLED=0 go build -trimpath \
        -ldflags="-s -w -X main.Version=${VERSION}" \
        -o /app ./cmd/app/
    
    # Runtime stage
    FROM alpine@sha256:...
    COPY --from=builder /app /usr/local/bin/app
    ENTRYPOINT ["app"]
    

    Key points:

    • Tests run in the build stage because they may require compiled artifacts or heavier dependencies.
    • ARG CHECK_EPOCH must be declared in every stage containing a check-running RUN, because ARG is stage-scoped: declaring it in one stage leaves the others frozen at their last cached result while the fix reviews as complete. In each such stage the guard sits immediately below the ARG, and the value is expanded into the first check RUN so the cache miss does not rely on BuildKit's unreferenced-ARG handling. Both lines reference $CHECK_EPOCH, so each stage has two independent invalidation points. Later RUNs in the same stage need no expansion of their own: their parent layer is already busted.
    • ARG VERSION=dev is declared in the build stage, and its value is supplied on the host by script/docker and script/cibuild via --build-arg VERSION=.... The dev default is a placeholder for a local build, not a source of truth. No stage may call git describe: .dockerignore excludes .git, so it yields an empty version without failing. See the git-describe rule further down.
  • Every repo should have a Gitea Actions workflow (.gitea/workflows/) that runs script/cibuild on push. script/cibuild runs two container builds: script/lint (Dockerfile.lint) first, then docker build --build-arg CHECK_EPOCH="$epoch" --build-arg VERSION="$version" . for the main image, which runs the non-lint checks. A successful script/cibuild therefore implies all checks pass; a successful docker build . on its own does not, because it never lints. That is the one claim to be careful with when reading these files: the guarantee belongs to script/cibuild, not to any single Dockerfile. Both halves of it hold only because each build passes its own CHECK_EPOCH nonce — without it an unchanged tree serves the layers from cache and the build reports a green it never earned. A bare docker build . or docker build -f Dockerfile.lint . fails closed by design, on the [ -n "$CHECK_EPOCH" ] guard; always go through script/cibuild, script/docker or script/lint. Never accept a pass as evidence without confirming it ran: a sub-second wall time, or CACHED on a check or lint layer, means nothing was executed.

  • Use platform-standard formatters: black for Python, prettier for JS/CSS/Markdown/HTML, go fmt for Go. Always use default configuration with two exceptions: four-space indents (except Go), and proseWrap: always for Markdown (hard-wrap at 80 columns). Documentation and writing repos (Markdown, HTML, CSS) should also have .prettierrc and .prettierignore.

  • Pre-commit hook: runs script/precommit, which calls script/check. If local testing is not possible in the repo, script/precommit may skip script/test and run only script/lint and script/fmt-check. The hook is installed by script/install-precommit; the Makefile must provide a make hooks target that shims to it.

  • All repos with software must have tests that run via the platform-standard test framework (go test, pytest, jest/vitest, etc.). If no meaningful tests exist yet, add the most minimal test possible — e.g. importing the module under test to verify it compiles/parses. There is no excuse for make test to be a no-op.

  • make test must complete in under 20 seconds. Add a 30-second timeout in the Makefile.

  • make test should use the conditional verbose rerun pattern. Run tests without -v (verbose) first. If tests fail, automatically rerun with -v to show full output. This keeps CI logs and docker build output clean on success (just package/suite summaries) while providing full diagnostic detail on failure (every test case, every assertion). The general shell pattern:

    test:
    	@<test-command> || \
    		{ echo "--- Rerunning with -v for details ---"; \
    		  <test-command-with-v>; exit 1; }
    

    Go example:

    test:
    	@go test -timeout 30s -race -cover ./... || \
    		{ echo "--- Rerunning with -v for details ---"; \
    		  go test -timeout 30s -race -v ./...; exit 1; }
    

    Python example:

    test:
    	@python -m pytest || \
    		{ echo "--- Rerunning with -v for details ---"; \
    		  python -m pytest -v; exit 1; }
    

    The exit 1 ensures the target always fails after a rerun — the first run already proved the tests are broken, so the build must not pass even if a flaky test happens to succeed on the second attempt. The rerun exists solely for diagnostic output.

  • Docker builds must complete in under 5 minutes.

  • make check must not modify any files in the repo. Tests may use temporary directories.

  • main must always pass make check, no exceptions.

  • Never commit secrets. .env files, credentials, API keys, and private keys must be in .gitignore. No exceptions.

  • .gitignore should be comprehensive from the start: OS files (.DS_Store), editor files (.swp, *~), in-repo agent scratch directories (.claude/, which holds one worktree — an entire additional checkout of the repo — per in-flight agent), language build artifacts, and node_modules/. Fetch the standard .gitignore from https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore when setting up a new repo. These patterns are written to .gitignore's own semantics, in which an unanchored pattern already matches at every depth. They are not a .dockerignore and must not be transplanted into one unmodified — see the next rule.

  • .dockerignore does not use .gitignore semantics, and copying patterns across unmodified leaves secrets in the build context. Docker matches with moby/patternmatcher: Go filepath.Match semantics plus a ** extension, compiled to a regexp — plain filepath.Match has no ** at all. So * does not cross /, and a pattern without a leading **/ is anchored at the build-context root. A .dockerignore listing .env, *.pem and *.key therefore excludes only the copies at the repository root; config/.env and certs/server.key still reach the context and can land in an image layer. That file is more dangerous than a short one with no secret patterns at all, because it reads as solved and stops anyone looking. Give every depth-independent pattern the **/ prefix — **/node_modules, **/.DS_Store, and the secret patterns in the canonical file, which are additionally case-folded per the rule below — and leave only genuinely root-anchored entries unprefixed: .git, the in-repo agent scratch directory .claude, and the repo's own host-built binary. The inverse move is equally wrong: never apply **/ to .gitignore, where it is redundant and produces a file that is wrong in a way that looks careful. Each file is written to its own semantics; neither is derived from the other. Fetch the standard .dockerignore from https://git.eeqj.de/sneak/prompts/raw/branch/main/.dockerignore and extend it with the repo's own host-built artifacts — a host make build that leaves a compiled binary in the repo root puts that binary in the build context, where .gitignore hides it from every git-based check. Write that binary anchored, /myapp and never **/myapp: the prefixed form also matches cmd/myapp/ and deletes the package directory from the context.

  • In-repo agent scratch belongs in both files, written to each file's own semantics. .claude/ holds one worktree per in-flight agent — an entire additional checkout of the repo — so with COPY . . the build context inflates by a multiple of the repo, and another session's unreviewed, sometimes uncommitted work can be copied into an image layer. The directory is also created and destroyed constantly, so it invalidates COPY . . for reasons that have nothing to do with the repo's own content. And because Dockerfile.lint and Dockerfile run their tooling over the copied context, a worktree that reaches it is linted and tested as though it were the repo. Nothing else stops that: language toolchains discover files by walking the tree and do not read .gitignore, which is how sneak/quak saw a nested .claude/ worktree take its discovered test count from 210 to 1050 (sneak/quak#30). This entry is therefore a correctness precondition of the containerised-lint rule above and not a size optimisation — without it the foreign-tree false reds that rule exists to end simply move inside the container. In .gitignore the entry is .claude/, unanchored, which already matches at every depth. In .dockerignore it is .claude, anchored and with no **/ prefix: the directory occurs exactly once where agents run at the repo root, and the prefixed form would also match any nested directory of that name and delete it from the build. It is not case-folded the way the secret patterns are, because tooling creates it in exactly one spelling, so a folded pattern would add no coverage.

    Known gap that comes with the anchored form. The directory is created in the agent's working directory, so the "exactly once, at the root" premise is a property of how agents are run and not of the tooling. Where agents run in subdirectories — a monorepo with a per-service agent is the ordinary case — services/api/.claude/ is not excluded by the canonical entry and still reaches the build context and the image, which is the exposure the entry exists to close. A repo in that shape adds its own anchored entries (/services/api/.claude), or **/.claude once it has confirmed no legitimately named nested directory would be caught. This is stated in the canonical .dockerignore itself, since that file is what consuming repos receive.

  • .dockerignore matching is case-sensitive, so cover capitalisation with character classes rather than by doubling patterns. **/*.key does not match certs/SERVER.KEY, which is reachable on the case-insensitive filesystems most laptops use. Adding an ALL-CAPS twin for each pattern is not the fix: it still misses Server.Key and Ca.Pem while reading as though case were handled — the same manufactured confidence as the root-anchored form. The matcher supports character ranges, so one line covers every spelling: **/*.[kK][eE][yY], **/*.[pP][eE][mM]. Apply this to every secret name, not only to extensions: the extensionless SSH keys and .envrc need it for the same reason, since on the very filesystems that make SERVER.KEY reachable, direnv reads .ENVRC and ssh reads ID_RSA. Note that * matches the empty string, so **/*.[eE][nN][vV] already covers a bare .ENV and no separate literal .env entry is needed.

  • A pattern that also catches something the build needs is re-included with a negation, not deleted. The canonical **/*.[eE][nN][vV] excludes a committed env template such as example.env; a repo whose build genuinely reads one adds !docs/example.env after the pattern. Deleting the pattern instead reopens the exposure for every other file it covers.

  • Verify .dockerignore by enumerating the image, not by reading the patterns. Plant files at the root and at least two directories deep, build a probe image that does COPY . ., and list what actually landed (docker run --rm --entrypoint find IMAGE /app). Reading the patterns and agreeing they look right is exactly what lets the root-only form through. The transferring context size is not a substitute: a nested secret is a few bytes, and BuildKit transfers only the delta from the previous build, so the reported size describes the transfer and not the contents of the image.

  • Excluding .git means git describe cannot run inside any build stage, and it fails quietly there. The GOLDFLAGS version-embedding pattern assumes .git is present; in a build stage there is no repository, so git describe writes nothing to stdout and the -X main.Version= value comes out empty rather than erroring. The binary then reports no version at all and the build still exits 0. Compute the version on the host and thread it in as a build arg. script/docker and script/cibuild do this, byte-identically across repos:

    # Assign on its own line: a failing command substitution inside an
    # argument does not trip `set -e`, so the inline form degrades to an
    # empty constant — the same silent-empty failure this rule is about.
    version="$(git describe --tags --always --dirty 2>/dev/null || true)"
    [ -n "$version" ] || version="unknown"
    docker build \
        --build-arg CHECK_EPOCH="$epoch" \
        --build-arg VERSION="$version" \
        .
    

    --always makes an untagged repo yield the abbreviated commit hash instead of failing. || true keeps a failing git describe from tripping set -e and leaves the value empty, so the [ -n "$version" ] line is the single place the fallback is applied — and it is a live check, not defence in depth: it fires on a build from an export with no .git, and on a repository with no commits yet. Do not fold the fallback into the substitution as || echo unknown; that makes the guard unreachable, and a guard that cannot fire is indistinguishable from one that works to everyone who copies it. The result is non-empty by construction either way, which is the point: an empty version reads as a successful one, while unknown is visibly wrong. The Dockerfile's side is ARG VERSION=dev in the stage that compiles, declared there and not inherited, because ARG is stage-scoped exactly as CHECK_EPOCH is. Passing VERSION to a repo whose Dockerfile declares no such ARG is silently ignored by BuildKit and costs nothing, which is why the scripts stay byte-identical rather than growing a per-repo variant.

    One consequence for CI: the standard checkout action clones shallow and fetches no tags, so git describe --tags there falls back to a bare commit hash. A repo that embeds a tag-derived version must set fetch-depth: 0 on its checkout step; a repo that does not embed a version needs no change.

  • No build artifacts in version control. Code-derived data (compiled bundles, minified output, generated assets) must never be committed to the repository if it can be avoided. The build process (e.g. Dockerfile, Makefile) should generate these at build time. Notable exception: Go protobuf generated files (.pb.go) ARE committed because repos need to work with go get, which downloads code but does not execute code generation.

  • Never use git add -A or git add .. Always stage files explicitly by name.

  • Never force-push to main.

  • Make all changes on a feature branch. You can do whatever you want on a feature branch.

  • .golangci.yml is standardized and must NEVER be modified by an agent, only manually by the user. Fetch from https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml. The canonical golangci-lint version is v2.12.2 (released 2026-05-06), pinned as the image digest in Dockerfile.lint (golangci/golangci-lint@sha256:5cceeef04e53efe1470638d4b4b4f5ceefd574955ab3941b2d9a68a8c9ad5240, which reports golangci-lint has version 2.12.2 built with go1.26.2 from c0d3ddc9). That digest is the only pin there is: the linter is not installed on the host, in script/bootstrap or anywhere else. Bumping the version means changing that one digest, and it propagates to every consumer of the image with no host state able to disagree with it.

  • script/bootstrap must not install a linter at all. This supersedes the pinned-golangci-lint install that used to be canonical here. Nothing runs a linter on the host any more — script/lint is a container build — so a host install has no caller left, and its only remaining effect is to put a second, independently-versioned linter on the machine where somebody will eventually run it by hand and believe the result. The version-skew failures that install was written to close (a local make check green while make docker rejected the same commit with six goconst findings; a container linter surfacing thirteen findings the host run missed) are closed more completely by having exactly one linter, pinned by image digest, that no host state can shadow. Repos adopting the containerised lint delete the install block, its version and ref variables, and its call site from script/bootstrap.

    The version-enforcement principle it established still applies to any other tool a repo pins and installs on the host, and it is the part worth keeping, because each of its four properties guards a failure that otherwise reports success:

    • Compare the installed version against the pin, never test presence. A if missing <tool>; then install; fi guard tests PATH presence and never version, so on any already-provisioned machine the pin is inert and a version bump is a silent no-op. Compare the whole version token, exactly: a parser that stops at the first - reports 2.12.2 for a host running 2.12.2-rc1 and skips the install — the original defect, reintroduced through the comparison meant to fix it.
    • After installing, re-resolve the binary the way callers resolve it — through PATH, not the directory the installer wrote to — and assert the reported version is the pin. An installer that writes to GOBIN while a different binary shadows it earlier in PATH genuinely succeeds and changes nothing any caller sees, which is worse than no fix: it converts a known-stale tool into one everyone believes is pinned. Run hash -r first so the shell does not answer from its own lookup cache, and when the assertion fails, name the path command -v found, the version it reports, and the directory the install wrote to. Diagnose from the resolved path rather than asserting a cause: only a path outside the install directory is shadowing.
    • A mis-parse must fall through to reinstall, never to a false match. Absent binary, non-zero exit, empty output and unrecognised output should all yield an empty string, which compares unequal to the pin. The failure direction is always a redundant install, never a skipped one.
    • Call it, and say so on success. A function defined and never called is a silent no-op indistinguishable from success: exit 0, nothing installed, no output. Both success branches must print a line naming the version.

    Verifying such logic requires a negative control in an environment where a shadowing binary exists earlier in PATH than the install target — without it the control passes against the naive compare-then-install form too and proves nothing — plus a mis-parse control that feeds unparseable --version output and confirms a reinstall. Run those controls against the block as a consuming repo would adopt it: pasted into a script/bootstrap-shaped file that is then executed, never by sourcing it and invoking the function yourself. Driving the function directly tests something the artifact does not do, and it is exactly how a missing call site passes every control while the adopted snippet does nothing.

    Keep it POSIX sh: no bashisms, no arrays, no [[, no grep -P.

  • SUPERSEDED, and deleted rather than kept: the per-checkout GOLANGCI_LINT_CACHE/TMPDIR wrapper for script/lint. Every line of it was about making a linter run on a shared host trustworthy — a private result cache so a byte-identical checkout could not serve its findings, a private TMPDIR so the host-global lock could not collide, retry and VOID handling so a lock collision was never reported as findings. The containerised-lint rule above removes the host run itself, so there is nothing left for that wrapper to isolate, and a repo carrying both would carry two contradictory canonical script/lint forms. Its findings are not lost: they are the evidence for containerising, and they are recorded in that rule. Repos that adopted it delete the wrapper, the .lint-cache/ entries from .gitignore and .dockerignore, and the --allow-serial-runners flag with them.

    Two of its conclusions are kept because they outlive it. GOCACHE does not need isolating, measured rather than assumed: it is content-addressed, its entries are compiled artifacts rather than diagnostics carrying a foreign tree's paths, and it has no equivalent global lock — the whole fleet compiles concurrently against one GOCACHE all day without a contention error. And verifying any change to lint plumbing requires paired controls: a control that passes against the broken form proves nothing, and it must be run against the artifact as a consuming repo would adopt it — the file executed, not the functions sourced and driven by hand.

  • Interim rule for reading a lint result produced on the host, in a repo that has not yet adopted the containerised lint above. A lint run is VOID unless both hold:

    • the output contains no parallel golangci-lint is running, and
    • no reported file path begins with ../, and none is an absolute path outside the tree the run was launched from.

    Do not record a verdict from a void run, and do not "fix" findings in files the change does not touch — chasing phantom findings across untouched files puts unrelated edits into a reviewed diff, which is more expensive than the wasted rework.

    The ../ clause is the one that actually bites, and it is why a filter keyed on /tmp or on absolute prefixes is not enough: golangci-lint reports paths relative to its own resolved root rather than yours, and three of the org's reported sightings had relative paths and would have passed such a filter. Both clauses are needed and neither alone is sufficient — one reproduction exited non-zero with the lock error and no foreign paths at all, and another reported 34 well-formed findings, every one of them against another checkout.

    State the limit of these tests rather than treating them as a guarantee. They catch contamination that names foreign files. They cannot catch contamination that suppresses findings through a poisoned entry for colliding content, which has no wall-clock tell either — no evidence of that mode has been observed, and nobody should go chasing it; the point is the reach of the tests, not a claim that the mode exists. They are a filter for the loud mode, not a proof of soundness — which is the whole argument for containerising the linter instead of documenting a discipline that depends on every agent remembering to apply it. Adopt the rule above and this one stops applying to the repo entirely.

  • When pinning images or packages by hash, add a comment above the reference with the version and date (YYYY-MM-DD).

  • Use yarn, not npm.

  • Write all dates as YYYY-MM-DD (ISO 8601).

  • Simple projects should be configured with environment variables.

  • Dockerized web services listen on port 8080 by default, overridable with PORT.

  • HTTP/web services must be hardened for production internet exposure before tagging 1.0. This means full compliance with security best practices including, without limitation, all of the following:

    • Security headers on every response:
      • Strict-Transport-Security (HSTS) with max-age of at least one year and includeSubDomains.
      • Content-Security-Policy (CSP) with a restrictive default policy (default-src 'self' as a baseline, tightened per-resource as needed). Never use unsafe-inline or unsafe-eval unless unavoidable, and document the reason.
      • X-Frame-Options: DENY (or SAMEORIGIN if framing is required). Prefer the frame-ancestors CSP directive as the primary control.
      • X-Content-Type-Options: nosniff.
      • Referrer-Policy: strict-origin-when-cross-origin (or stricter).
      • Permissions-Policy restricting access to browser features the application does not use (camera, microphone, geolocation, etc.).
    • Request and response limits:
      • Maximum request body size enforced on all endpoints (e.g. Go http.MaxBytesReader). Choose a sane default per-route; never accept unbounded input.
      • Maximum response body size where applicable (e.g. paginated APIs).
      • ReadTimeout and ReadHeaderTimeout on the http.Server to defend against slowloris attacks.
      • WriteTimeout on the http.Server.
      • IdleTimeout on the http.Server.
      • Per-handler execution time limits via context.WithTimeout or chi/stdlib middleware.Timeout.
    • Authentication and session security:
      • Rate limiting on password-based authentication endpoints. API keys are high-entropy and not susceptible to brute force, so they are exempt.
      • CSRF tokens on all state-mutating HTML forms. API endpoints authenticated via Authorization header (Bearer token, API key) are exempt because the browser does not attach these automatically.
      • Passwords stored using bcrypt, scrypt, or argon2 — never plain-text, MD5, or SHA.
      • Session cookies set with HttpOnly, Secure, and SameSite=Lax (or Strict) attributes.
    • Reverse proxy awareness:
      • True client IP detection when behind a reverse proxy (X-Forwarded-For, X-Real-IP). The application must accept forwarded headers only from a configured set of trusted proxy addresses — never trust X-Forwarded-For unconditionally.
    • CORS:
      • Authenticated endpoints must restrict Access-Control-Allow-Origin to an explicit allowlist of known origins. Wildcard (*) is acceptable only for public, unauthenticated read-only APIs.
    • Error handling:
      • Internal errors must never leak stack traces, SQL queries, file paths, or other implementation details to the client. Return generic error messages in production; detailed errors only when DEBUG is enabled.
    • TLS:
      • Services never terminate TLS directly. They are always deployed behind a TLS-terminating reverse proxy. The service itself listens on plain HTTP. However, HSTS headers and Secure cookie flags must still be set by the application so that the browser enforces HTTPS end-to-end.

    This list is non-exhaustive. Apply defense-in-depth: if a standard security hardening measure exists for HTTP services and is not listed here, it is still expected. When in doubt, harden.

  • README.md is the primary documentation. Required sections:

    • Description: First line must include the project name, purpose, category (web server, SPA, CLI tool, etc.), license, and author. Example: "µPaaS is an MIT-licensed Go web application by @sneak that receives git-frontend webhooks and deploys applications via Docker in realtime."
    • Getting Started: Copy-pasteable install/usage code block.
    • Entrypoints: Opens by stating that the repo adheres to the Scripts to Rule Them All standard (with that link), then documents each provided script/ entrypoint and its purpose.
    • Rationale: Why does this exist?
    • Design: How is the program structured?
    • TODO: Update meticulously, even between commits. When planning, put the todo list in the README so a new agent can pick up where the last one left off.
    • License: MIT, GPL, or WTFPL. Ask the user for new projects. Include a LICENSE file in the repo root and a License section in the README.
    • Author: @sneak.
  • First commit of a new repo should contain only README.md.

  • Go module root: sneak.berlin/go/<name>. Always run go mod tidy before committing.

  • Use SemVer.

  • Database migrations live in internal/db/migrations/ and must be embedded in the binary.

    • 000_migration.sql — contains ONLY the creation of the migrations tracking table itself. Nothing else.
    • 001_schema.sql — the full application schema.
    • Pre-1.0.0: never add additional migration files (002, 003, etc.). There is no installed base to migrate. Edit 001_schema.sql directly.
    • Post-1.0.0: add new numbered migration files for each schema change. Never edit existing migrations after release.
  • All repos should have an .editorconfig enforcing the project's indentation settings.

  • Avoid putting files in the repo root unless necessary. Root should contain only project-level config files (README.md, Makefile, Dockerfile, LICENSE, .gitignore, .editorconfig, REPO_POLICIES.md, and language-specific config). Everything else goes in a subdirectory. Canonical subdirectory names:

    • bin/ — executable scripts and tools
    • cmd/ — Go command entrypoints
    • configs/ — configuration templates and examples
    • deploy/ — deployment manifests (k8s, compose, terraform)
    • docs/ — documentation and markdown (README.md stays in root)
    • internal/ — Go internal packages
    • internal/db/migrations/ — database migrations
    • pkg/ — Go library packages
    • share/ — systemd units, data files
    • static/ — static assets (images, fonts, etc.)
    • web/ — web frontend source
  • When setting up a new repo, files from the prompts repo may be used as templates. Fetch them from https://git.eeqj.de/sneak/prompts/raw/branch/main/<path>.

  • New repos must contain at minimum:

    • README.md, .git, .gitignore, .editorconfig
    • LICENSE, REPO_POLICIES.md (copy from the prompts repo)
    • Makefile
    • script/ entrypoints (bootstrap, setup, projectname, test, lint, fmt, fmt-check, check, docker, cibuild, precommit, install-precommit)
    • Dockerfile, .dockerignore
    • .gitea/workflows/check.yml
    • Go: go.mod, go.sum, .golangci.yml
    • JS: package.json, yarn.lock, .prettierrc, .prettierignore
    • Python: pyproject.toml