REPO_POLICIES: script/ entrypoints are the single source of truth #157

Merged
clawbot merged 1 commits from issue-155-script-entrypoints into next 2026-11-06 01:18:53 +01:00
+6 -5
View File
@@ -1,6 +1,6 @@
--- ---
title: Repository Policies title: Repository Policies
last_modified: 2026-11-04 last_modified: 2026-11-06
--- ---
This document covers repository structure, tooling, and workflow standards. Code This document covers repository structure, tooling, and workflow standards. Code
@@ -199,14 +199,15 @@ style conventions are in separate documents:
README must document the provided scripts in an **Entrypoints** section (see README must document the provided scripts in an **Entrypoints** section (see
the README requirements below). the README requirements below).
- Always use Makefile targets (`make fmt`, `make test`, `make lint`, etc.) - Run the repo's own entrypoints, never the underlying tools directly. The
instead of invoking the underlying tools directly. The Makefile is the single `script/` scripts are the single source of truth for how each operation runs.
source of truth for how these operations are run. Calling them directly is fine, and so is calling the Makefile targets. The
Makefile targets must still exist, as the thin shims described above.
An agent whose work is confined to one package may run `go test` directly on An agent whose work is confined to one package may run `go test` directly on
that package's suite, or on individual tests in it, while iterating. This is that package's suite, or on individual tests in it, while iterating. This is
the only exception to this rule. `go build`, `go vet` and the linter still the only exception to this rule. `go build`, `go vet` and the linter still
go through make targets. A run while iterating is not a gate, so the full go through the entrypoints. A run while iterating is not a gate, so the full
`make check` is still required before every push. `make check` is still required before every push.
- The Makefile is authoritative documentation for how the repo is used. Beyond - The Makefile is authoritative documentation for how the repo is used. Beyond