Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1fec3be0e3 | ||
|
|
7389dcbcc1 | ||
|
|
ebf9475aad | ||
|
|
62b56a2024 | ||
|
|
feeb1d4cb8 | ||
|
|
5cf6e64857 | ||
|
|
ccb49b0f5e |
No files matched your search
@@ -175,7 +175,24 @@ share, and evolve prompts across projects.
|
||||
The repository is a collection of Markdown files organized in the `prompts/`
|
||||
subdirectory. Each file contains one or more related prompts or policy
|
||||
documents. There is no build step or runtime component; the prompts are consumed
|
||||
by copying them into other projects or referencing them directly.
|
||||
by copying them into other projects or referencing them directly. `examples/`
|
||||
holds the example `Dockerfile` files that `prompts/REPO_POLICIES.md` links to.
|
||||
|
||||
## Template Repos
|
||||
|
||||
These template repositories implement the policies defined in this repo and
|
||||
serve as starting points for new projects. They must be kept in sync when
|
||||
policies change.
|
||||
|
||||
- **[template-app-go](https://git.eeqj.de/sneak/template-app-go)** — Go HTTP
|
||||
server template (Uber fx, chi, SQLite, session auth, Prometheus metrics)
|
||||
- **[template-app-js](https://git.eeqj.de/sneak/template-app-js)** — JavaScript
|
||||
SPA template (Vite, Tailwind CSS v4, nginx Docker deployment)
|
||||
- **[template-app-python](https://git.eeqj.de/sneak/template-app-python)** —
|
||||
Python web application template (FastAPI, uvicorn, pytest, black, ruff)
|
||||
|
||||
When updating policies in this repo, also update the template repos to match
|
||||
(Makefile targets, Dockerfile conventions, CI workflows, required files, etc.).
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
FROM golangci/golangci-lint@sha256:... AS lint
|
||||
RUN apt-get update \
|
||||
&& apt-get install -y --no-install-recommends libvips-dev \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
WORKDIR /src
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
ARG CACHEBUST
|
||||
@@ -0,0 +1,85 @@
|
||||
# In every stage ARG CACHEBUST comes right after the steps that install
|
||||
# system packages and download Go's modules, or right after FROM in a
|
||||
# stage with neither, and every step that lints, tests or compiles
|
||||
# comes after it. script/ passes a new value on every build, which
|
||||
# reruns every RUN step after it. Docker keeps the layers above it
|
||||
# until the base image, their own lines or go.mod and go.sum change.
|
||||
# The steps that compile mount Go's build cache, and golangci-lint run
|
||||
# also mounts golangci-lint's; both survive from build to build.
|
||||
|
||||
# Lint phase
|
||||
# golangci/golangci-lint:v2.x.x, YYYY-MM-DD
|
||||
FROM golangci/golangci-lint@sha256:... AS lint
|
||||
WORKDIR /src
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
ARG CACHEBUST
|
||||
COPY . .
|
||||
RUN --mount=type=cache,target=/root/.cache/go-build \
|
||||
--mount=type=cache,target=/root/.cache/golangci-lint \
|
||||
golangci-lint run --config .golangci.yml ./...
|
||||
|
||||
# Test phase. -race needs cgo and so a C compiler, which the Debian Go
|
||||
# image ships and the alpine one does not. -count=1 because the mounted
|
||||
# cache also holds test results, which go test would otherwise replay.
|
||||
# A first run that timed out gets no rerun, because a rerun would only
|
||||
# wait for the same hang.
|
||||
# golang:1.x, YYYY-MM-DD
|
||||
FROM golang@sha256:... AS test
|
||||
WORKDIR /src
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
ARG CACHEBUST
|
||||
COPY . .
|
||||
RUN --mount=type=cache,target=/root/.cache/go-build \
|
||||
status=0; \
|
||||
output=$(go test -count=1 -timeout 90s -race -cover ./... 2>&1) || status=$?; \
|
||||
printf '%s\n' "$output"; \
|
||||
test "$status" -eq 0 && exit 0; \
|
||||
case "$output" in \
|
||||
*"panic: test timed out"*|*"*** Test killed"*) exit 1 ;; \
|
||||
esac; \
|
||||
echo "--- Rerunning with -v for details ---"; \
|
||||
go test -count=1 -timeout 90s -race -v ./...; \
|
||||
exit 1
|
||||
|
||||
# Build stage. Nothing is wanted from either phase above; the copies
|
||||
# are what make BuildKit build them first, so nothing after them can
|
||||
# run unless lint and test passed.
|
||||
# golang:1.x-alpine, YYYY-MM-DD
|
||||
FROM golang@sha256:... AS builder
|
||||
# git comes from the base image's own distribution package index, which
|
||||
# is trusted, so it needs no version and no hash.
|
||||
RUN apk add --no-cache git
|
||||
WORKDIR /src
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
ARG CACHEBUST
|
||||
COPY --from=lint /src/go.sum /dev/null
|
||||
COPY --from=test /src/go.sum /dev/null
|
||||
# A tar-stream context keeps the sender's file owners, which git refuses.
|
||||
RUN git config --system --add safe.directory /src
|
||||
COPY . .
|
||||
|
||||
# The VERSION build arg when one is given, otherwise
|
||||
# `git describe --tags --always` on the .git in the build context. With
|
||||
# .git present, a version that is still empty, dev or unknown fails the
|
||||
# build: git is missing or could not read the checkout.
|
||||
ARG VERSION
|
||||
RUN --mount=type=cache,target=/root/.cache/go-build \
|
||||
VERSION="${VERSION:-$(git describe --tags --always)}"; \
|
||||
if [ -e .git ]; then \
|
||||
case "$VERSION" in ""|dev|unknown) \
|
||||
echo "version is '$VERSION' although .git is present" >&2; \
|
||||
exit 1 ;; \
|
||||
esac; \
|
||||
fi; \
|
||||
CGO_ENABLED=0 go build -trimpath \
|
||||
-ldflags="-s -w -X main.Version=${VERSION}" \
|
||||
-o /app ./cmd/app/
|
||||
|
||||
# Runtime stage, and the last one
|
||||
FROM alpine@sha256:...
|
||||
ARG CACHEBUST
|
||||
COPY --from=builder /app /usr/local/bin/app
|
||||
ENTRYPOINT ["app"]
|
||||
@@ -0,0 +1,24 @@
|
||||
# Test phase. Both pytest runs share one 90-second timeout, so a hang
|
||||
# uses it once and gets no rerun.
|
||||
# debian:trixie-slim, YYYY-MM-DD
|
||||
FROM debian@sha256:... AS test
|
||||
# Python, pip and venv come from the distribution, which is trusted, so
|
||||
# they need no version and no hash. make and git are base tools that
|
||||
# script/bootstrap installs when they are missing. Installed here, they
|
||||
# stay in their own layer when script/ changes.
|
||||
RUN apt-get update \
|
||||
&& apt-get install -y --no-install-recommends ca-certificates make git \
|
||||
python3 python3-venv \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
# script/bootstrap installs pipenv in a virtual environment at
|
||||
# $HOME/.pipenv, and the tests below run that pipenv.
|
||||
ENV PATH=/root/.pipenv/bin:$PATH
|
||||
WORKDIR /app
|
||||
COPY script/ script/
|
||||
COPY Pipfile Pipfile.lock ./
|
||||
RUN script/bootstrap
|
||||
ARG CACHEBUST
|
||||
COPY . .
|
||||
RUN timeout 90 sh -c 'pipenv run pytest || { \
|
||||
echo "--- Rerunning with -v for details ---"; \
|
||||
pipenv run pytest -v; exit 1; }'
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Code Styleguide — Go
|
||||
last_modified: 2026-11-16
|
||||
last_modified: 2026-11-07
|
||||
---
|
||||
|
||||
1. Format Go code with `gofmt` and then `golines -m 77`, through `make fmt`.
|
||||
@@ -176,7 +176,7 @@ last_modified: 2026-11-16
|
||||
them a bit long.
|
||||
|
||||
1. Use descriptive names for modules and filenames. Avoid generic names like
|
||||
`server`. The rules for package names are under Naming, below.
|
||||
`server`. `util` is banned.
|
||||
|
||||
1. Constructors **must** take a `Params` struct (or `ThingParams` when
|
||||
`NewThing()` is used), even for a single argument. Named fields in a Params
|
||||
@@ -487,102 +487,6 @@ last_modified: 2026-11-16
|
||||
releasable". "Releasable" in this context means that it builds and functions
|
||||
as expected, and that all tests and linting passes.
|
||||
|
||||
# Naming
|
||||
|
||||
Judge a name where it is read. A caller writes the package name, a dot and the
|
||||
exported name, and reads them as one name: `http.Server`, `list.New`.
|
||||
|
||||
## Package names
|
||||
|
||||
1. Name a package for what it provides (`time`, `list`, `http`), because the
|
||||
caller writes that name in front of everything the package exports.
|
||||
|
||||
1. Write a package name in lowercase letters and digits only, with its words
|
||||
run together (`tabwriter`, never `tab_writer` or `tabWriter`), because that
|
||||
is how the standard library spells every package name.
|
||||
|
||||
1. Never name a package `model`, `models`, `util`, `utils`, `common`, `misc`,
|
||||
`helper`, `helpers`, `types`, `interfaces` or `api`, or anything else that
|
||||
says nothing about what is in it: every program has a data model, helpers
|
||||
and types. Name the package for the one thing its code is about; when its
|
||||
code is about several things, split it first (`stringset`, not `util`).
|
||||
|
||||
1. Spell a word out unless its short form is the one everybody already uses
|
||||
(`fmt`, `strconv`), because any other abbreviation has to be decoded.
|
||||
|
||||
1. Never give a package a name that callers want for a variable (`buf`,
|
||||
`count`) or that a widely used standard package has (`log`, `http`, `url`),
|
||||
because every importer then has to rename one of the two. Use a longer name
|
||||
that says which one: `bufio`, `usercount`.
|
||||
|
||||
1. Give a package's directory the package's name, package `main` excepted, so
|
||||
that the import path ends in the name the code uses.
|
||||
|
||||
1. Name a package that supports the tests of one package after that package
|
||||
plus `test` (`storetest`, never `testutil` or `testhelper`), because the
|
||||
name then says whose tests it is for.
|
||||
|
||||
1. Import a package under its own name. Give it a local name only when two
|
||||
imports have the same name or its own name breaks these rules, and use that
|
||||
local name in every file, so that one name always means one package.
|
||||
|
||||
## Exported names
|
||||
|
||||
1. Never repeat the package name inside a longer exported name (`http.Server`,
|
||||
not `http.HTTPServer`; `yamlconfig.Parse`, not
|
||||
`yamlconfig.ParseYAMLConfig`), because the caller has already written it.
|
||||
The type a package is named for may carry the same name on its own:
|
||||
`list.List`, `time.Time`.
|
||||
|
||||
1. Use the same plain name in two packages when it fits both (`bufio.Reader`,
|
||||
`csv.Reader`), because the package name already tells them apart.
|
||||
|
||||
1. Leave the receiver's type out of a method name, and the parameter and result
|
||||
types out of a function name (`(c *Config) WriteTo(w)`, not
|
||||
`WriteConfigTo`), because the signature already states them. Only when two
|
||||
functions differ in nothing but a type does the type go in, at the end:
|
||||
`ParseInt`, `ParseInt64`.
|
||||
|
||||
1. Name a function that returns a value for the value and one that acts for the
|
||||
action (`JobName(key)`, `WriteDetail(w)`), so that a call reads as what it
|
||||
gives or what it does.
|
||||
|
||||
1. Never start a getter with `Get` (`Owner()`, not `GetOwner()`; the setter is
|
||||
`SetOwner()`), because the capital letter already tells the method from the
|
||||
field. A call that goes to a database or the network takes a verb that says
|
||||
so (`Fetch`, `Load`), and `Get` stays only where it is the thing's own word,
|
||||
as in an HTTP GET.
|
||||
|
||||
1. Name a one-method interface for its method plus `er` (`Reader`,
|
||||
`Formatter`), because the name then says the one thing a value of it does.
|
||||
|
||||
1. Give a method that does what a well-known method does that method's name and
|
||||
signature: `String()`, never `ToString()`. Give a method that does anything
|
||||
else another name, because readers and the standard interfaces rely on
|
||||
`Read`, `Write`, `Close` and `String` meaning one thing.
|
||||
|
||||
1. Write an initialism in one case throughout (`ServeHTTP`, `appID`, `URL` or
|
||||
`url`; never `Url`, `Id` or `Http`), because that is how the standard
|
||||
library spells them.
|
||||
|
||||
1. Write a constant in MixedCaps like every other name (`MaxPacketSize`, never
|
||||
`MAX_PACKET_SIZE`), because an all-capitals name is exported whether or not
|
||||
that was meant.
|
||||
|
||||
1. Name an error value `Err` plus what went wrong (`ErrNotFound`) and an error
|
||||
type for what went wrong plus `Error` (`NotFoundError`), because callers
|
||||
know a package's errors by those two forms.
|
||||
|
||||
## Local names
|
||||
|
||||
1. Match a local name's length to the distance between its declaration and its
|
||||
last use (`i`, `r` and `db` across a few lines, a full word or two across a
|
||||
long function), because a reader far from the declaration has only the name.
|
||||
|
||||
1. Name a receiver with one or two letters, the same in every method of its
|
||||
type, never `this`, `self` or `me`, because it appears on nearly every line
|
||||
of those methods.
|
||||
|
||||
# Other Golang Tips and Best Practices (Optional)
|
||||
|
||||
1. For any internet-facing http server, set appropriate timeouts and limits to
|
||||
|
||||
@@ -71,8 +71,8 @@ with your task.
|
||||
also mounts golangci-lint's
|
||||
(`--mount=type=cache,target=/root/.cache/golangci-lint`), and no step
|
||||
mounts anything else; both `go test` runs carry `-count=1`; a first run
|
||||
that timed out gets no rerun, as in the canonical Go `Dockerfile` in
|
||||
`REPO_POLICIES.md`
|
||||
that timed out gets no rerun, as in `examples/go.Dockerfile` in the
|
||||
`prompts` repo
|
||||
- [ ] Python: a `test` phase that installs its packages from `Pipfile.lock` does
|
||||
it above `ARG CACHEBUST`, with `COPY script/ script/`,
|
||||
`COPY Pipfile Pipfile.lock ./` and `RUN script/bootstrap`. When
|
||||
@@ -92,8 +92,8 @@ with your task.
|
||||
installs no Python, because a step above it already did. `Pipfile` names no
|
||||
`python_version`, because `--deploy` stops when the distribution's Python
|
||||
differs from it. The tests run after `ARG CACHEBUST`, and every other stage
|
||||
installs its Python packages after it, as in the Python `test` phase example
|
||||
in `REPO_POLICIES.md`
|
||||
installs its Python packages after it, as in
|
||||
`examples/python-test-phase.Dockerfile` in the `prompts` repo
|
||||
|
||||
- [ ] The gate phases invoke their tools directly, never through `make lint` or
|
||||
`script/test` — those are themselves a `docker build` and would recurse
|
||||
@@ -163,7 +163,7 @@ with your task.
|
||||
- [ ] Go: `go.mod`, `go.sum`, `.golangci.yml` (fetch from
|
||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml` and,
|
||||
in the same commit, set the lint phase digest to the one named in the
|
||||
`.golangci.yml` paragraph of `REPO_POLICIES.md`)
|
||||
`.golangci.yml` section of `REPO_POLICIES.md`)
|
||||
- [ ] JS: `package.json`, `yarn.lock`, `.yarnrc.yml`, `.yarn/releases/`,
|
||||
`.gitattributes`, `.prettierrc`, `.prettierignore` (fetch the last two
|
||||
from `https://git.eeqj.de/sneak/prompts/raw/branch/main/.prettierrc`
|
||||
|
||||
@@ -140,8 +140,8 @@ Template files can be fetched from:
|
||||
also mounts golangci-lint's
|
||||
(`--mount=type=cache,target=/root/.cache/golangci-lint`), and no step
|
||||
mounts anything else; both `go test` runs carry `-count=1`; a first run
|
||||
that timed out gets no rerun, as in the canonical Go `Dockerfile` in
|
||||
`REPO_POLICIES.md`
|
||||
that timed out gets no rerun, as in `examples/go.Dockerfile` in the
|
||||
`prompts` repo
|
||||
- Python: a `test` phase that installs its packages from `Pipfile.lock` does
|
||||
it above `ARG CACHEBUST`, with `COPY script/ script/`,
|
||||
`COPY Pipfile Pipfile.lock ./` and `RUN script/bootstrap`. When
|
||||
@@ -162,8 +162,8 @@ Template files can be fetched from:
|
||||
because a step above it already did. `Pipfile` names no
|
||||
`python_version`, because `--deploy` stops when the distribution's
|
||||
Python differs from it. The tests run after `ARG CACHEBUST`, and every
|
||||
other stage installs its Python packages after it, as in the Python
|
||||
`test` phase example in `REPO_POLICIES.md`
|
||||
other stage installs its Python packages after it, as in
|
||||
`examples/python-test-phase.Dockerfile` in the `prompts` repo
|
||||
|
||||
- Server: the final stage builds and runs the application
|
||||
- Non-server: the final stage brings up the dev environment
|
||||
@@ -180,7 +180,7 @@ Template files can be fetched from:
|
||||
- [ ] Go: `go mod init sneak.berlin/go/<name>`, `.golangci.yml` (fetch from
|
||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml` and,
|
||||
in the same commit, set the lint phase digest to the one named in the
|
||||
`.golangci.yml` paragraph of `REPO_POLICIES.md`)
|
||||
`.golangci.yml` section of `REPO_POLICIES.md`)
|
||||
- [ ] JS, or any repository that runs prettier through yarn: make the first
|
||||
`yarn.lock` with the steps below. `script/bootstrap` installs no yarn
|
||||
until `yarn.lock` exists, so run them with any distribution's node and
|
||||
|
||||
+952
-1138
File diff suppressed because it is too large.
Load diff
@@ -8,8 +8,8 @@ ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
hook=".git/hooks/pre-commit"
|
||||
printf '#!/bin/sh\nset -e\nscript/precommit\n' > "$hook"
|
||||
chmod +x "$hook"
|
||||
printf '#!/bin/sh\nset -e\nscript/precommit\n' > .git/hooks/pre-commit
|
||||
chmod +x .git/hooks/pre-commit
|
||||
echo "pre-commit hook installed: runs script/precommit"
|
||||
}
|
||||
|
||||
|
||||
+3
-3
@@ -1,11 +1,11 @@
|
||||
#!/bin/sh
|
||||
# script/lint: run the linter. Linting is a phase of the Dockerfile and
|
||||
# this builds that phase; the linter is never installed or run on
|
||||
# this builds that phase alone; the linter is never installed or run on
|
||||
# a developer host, where a shared result cache and a host-global lock
|
||||
# make its answer untrustworthy.
|
||||
#
|
||||
# --target builds the lint phase and the stages it depends on, nothing
|
||||
# else. A new CACHEBUST value reruns every RUN step after
|
||||
# The phase is not the last stage in the file, so it is built only when
|
||||
# --target names it. A new CACHEBUST value reruns every RUN step after
|
||||
# the ARG CACHEBUST line, since a cached lint layer is a lint that did
|
||||
# not run; unlike --no-cache, it keeps the layers above that line and
|
||||
# the cache mounts. This relies on every stage of the Dockerfile
|
||||
|
||||
+3
-3
@@ -1,8 +1,8 @@
|
||||
#!/bin/sh
|
||||
# script/test: run the test suite. Testing is a phase of the Dockerfile
|
||||
# and this builds that phase, on the same terms as script/lint:
|
||||
# --target so that only the test phase and the stages it depends on are
|
||||
# built, and a new CACHEBUST value because a cached test layer is a test
|
||||
# and this builds that phase alone, on the same terms as script/lint:
|
||||
# --target because a phase that is not the last stage is built only when
|
||||
# named, and a new CACHEBUST value because a cached test layer is a test
|
||||
# that did not run; unlike --no-cache, it keeps the layers above the ARG
|
||||
# CACHEBUST line and the cache mounts. This relies on every stage of the
|
||||
# Dockerfile declaring ARG CACHEBUST before every step that lints, tests
|
||||
|
||||
Reference in new issue
Block a user