repo-tooling-architect
Repo-root developer tooling — .editorconfig, .gitignore, version pinning (mise default, proto alt), task runner (Task default, just alt), CI (GitHub Actions default, act for local/free runs), minimal
SKILL.mdskills/tooling/repo-tooling-architect/SKILL.md
GitHubRepo Tooling Architecture
Productivity files that live at the repo root, are language-agnostic, and shape how every contributor and CI step interacts with the code. Pairs with every language and framework architect skill. See STACK.md for pinned tool versions.
Decision model
Add a tool when all three are true:
- It pays back on day one. Not "useful eventually" — useful from the first PR.
- The cost of installing it is smaller than the cost of going without it. A 30-second install is fine; a 30-minute setup that breaks once per OS is not.
- There's no language-native option that already covers it.
go testdoesn't need a Makefile wrapper.uv rundoesn't needtaskfor one-language projects.
When in doubt, skip. Tools you add later are easy; tools you remove are political.
1. .editorconfig
Always include. Universal editor support, zero ceremony, ends the indent-style wars before they start.
# .editorconfig
root = true
[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.{go,Makefile}]
indent_style = tab
[*.{yml,yaml,json}]
indent_size = 2
[*.md]
trim_trailing_whitespace = false # Markdown uses trailing spaces for hard breaks
2. .gitignore
Always include. Curate per language; never copy a 500-line GitHub default that contains entries for languages you don't use.
- Use github.com/github/gitignore as the source for the base section per language.
- Trim aggressively. A clean
.gitignoreis documentation; a noisy one is noise. - Local-only exclusions (
.idea/,.vscode/settings.json) go in.git/info/excludeper-developer or~/.gitignore_global, not the repo's.gitignore.
3. Tool version pinning — mise (default), proto (alternative)
The problem: "works on my machine" because each dev has different Go / Python / Node versions. CI uses yet another version. Fix: pin every tool the repo needs in a file, install with one command.
Default: mise with mise.toml
# mise.toml
[tools]
go = "1.26"
python = "3.14"
node = "22"
task = "3.51"
golangci-lint = "2.12"
buf = "1.69"
trivy = "0.70"
mise install # installs everything pinned
- Why mise as default: broadest tool coverage via asdf-legacy plugins, available through
winget/brew/scoop. - Shell activation required:
eval "$(mise activate bash)"(or zsh/fish/pwsh equivalent).
Alternative: proto with .prototools
Same key-value shape, file named .prototools, install with proto install. Pick proto when you want strict separation (proto manages only binary versions; task handles env + tasks) and no shell-activation step (PATH-shim based). Trade-off: smaller plugin ecosystem; obscure tools may need a custom WASM plugin.
Either way: the pinned-versions file is committed; CI installs the same versions; nobody runs "whatever's on their machine."
4. Task runner — Task (default) or just (alternative)
The problem: every project has 5–15 commands a contributor needs to know (go build, go test --race, docker compose up -d db, task generate-contracts, etc.). Without a runner, they live in stale README sections.
Default: skip a task runner for single-language projects. go build, uv run, npm are enough. Don't wrap them in task build: aliases — that's ceremony.
Add a task runner when: multi-language repo, multi-service compose stack, or a meaningful number of multi-step commands.
Default: Task with Taskfile.yml
# Taskfile.yml
version: '3'
dotenv: ['.env', '.env.local']
tasks:
default:
desc: List all tasks
cmds:
- task --list
proto:generate:
desc: Regenerate Go code from .proto files
sources:
- 'proto/**/*.proto'
generates:
- 'internal/**/*.pb.go'
cmds:
- buf generate
test:unit:
desc: Run unit tests
cmds:
- go test ./...
test:race:
desc: Run all tests with race detector
cmds:
- go test -race ./...
docker:up:
desc: Start dev stack (DB + app)
cmds:
- docker compose up -d
docker:down:
desc: Stop dev stack
cmds:
- docker compose down
- Why Task as default: built-in
sources:/generates:for incremental builds,--watchmode, first-class Windows support (ships its own POSIX-sh interpreter), built-indotenv:loading. - Discoverability:
task --listshows every task with itsdesc.
Naming: module[:submodule…]:verb[:target|mode]. Name tasks after the thing they act on, then the action — proto:generate, git:update:recursive, docker:up:dev — not the reverse (generate-proto, run-tests). Environment and service are targets after the verb (docker:up:dev, not docker:dev:up). Cross-cutting actions use the inverse family, verb:target (test:backend, scan:fs). task --list groups alphabetically, so this puts every task for a module next to its siblings and reads as a discoverable namespace even without splitting files. Reserve unprefixed names (default, build, lint) for repo-wide entry points that don't belong to a single module.
The full grammar, the canonical verb/module vocabulary, the aggregate/atomic rule, include rules, and the standard Go-library task set are in TASKFILE.md. Read it before adding or renaming a task — the audit of the active repos found the same drift (git submodule names, env ordering, gen/generate, cover/coverage, be/fe) everywhere, and TASKFILE.md is the single answer to it.
For a large enough module to warrant its own file, promote the prefix to a real namespace with includes: — Task auto-prefixes every task in the included file, so docker:up becomes task docker:up whether it's a flat key or defined in Taskfile.docker.yml:
# Taskfile.yml
includes:
docker: ./Taskfile.docker.yml
proto: ./Taskfile.proto.yml
# Taskfile.docker.yml
version: '3'
tasks:
up:
desc: Start dev stack (DB + app)
cmds:
- docker compose up -d
down:
desc: Stop dev stack
cmds:
- docker compose down
Stay flat until a module earns its own file (5+ tasks, or config distinct enough to warrant separation) — splitting a two-task module into its own Taskfile.*.yml is ceremony the flat module:verb key already avoids.
Alternative: just with justfile
Makefile-style brevity over YAML; recipes look like shell. Add set windows-shell := [...] and set dotenv-load at the top. Pick just when you prefer terseness, don't need incremental builds, and all collaborators are on macOS/Linux. Trade-off: no native incremental builds, no --watch mode.
Settle on one per repo. Don't mix Taskfile.yml and justfile.
5. Pre-commit hooks — minimal, opt-in
The problem: minor issues (trailing whitespace, committed secrets, large files) reach CI when they could have been blocked locally. Fix: a tiny pre-commit hook set that catches only what can't be caught later or that's genuinely fast.
Strong opinions exist. Some teams love pre-commit; some find it slows commits / blocks WIP commits. The minimal-hook stance is the compromise: catch real risks, never run language-specific linters or formatters in commit hooks (those run in editor-on-save and again in CI).
.pre-commit-config.yaml — minimal set
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: trailing-whitespace
exclude: '\.md$' # markdown uses trailing space for hard breaks
- id: end-of-file-fixer
- id: check-added-large-files
args: ['--maxkb=500']
- id: check-merge-conflict
- id: check-yaml
- id: check-json
- repo: https://github.com/gitleaks/gitleaks
rev: v8.21.0
hooks:
- id: gitleaks # secret detection
- Install:
pre-commit installonce per clone. - Run on demand:
pre-commit run --all-files(or wire into a Task:task lint:precommit). - No language-specific linters.
ruff,golangci-lint, etc. run in editor (on save) and again in CI. Running them in a pre-commit hook duplicates work and slows commits. - Skip on a single commit:
git commit --no-verifyis fine; over-policing pre-commit erodes trust.
6. Environment variables
The problem: secrets and config diverge across machines, leak into git, or get exported globally and bleed across projects.
Pattern
- Non-secret config:
.env+.env.local, loaded by Task'sdotenv:directive..envis committed (defaults safe for any contributor —LOG_LEVEL=info,DB_HOST=localhost)..env.localis git-ignored (per-developer overrides —LOG_LEVEL=debug).
- Real secrets: external secret manager. Never in
.env, never committed:- 1Password CLI (
op run --env-file=.env.template -- task up) — solo / small team - doppler (
doppler run -- task up) — team - Cloud secret manager (AWS Secrets Manager, GCP Secret Manager) — production injection at runtime
- 1Password CLI (
- No
direnvunless you need automatic activation when youcdinto a directory. Task'sdotenv:covers the common case without a second tool.
.env shape
# .env — committed, safe defaults
LOG_LEVEL=info
APP_PORT=8080
DB_HOST=localhost
DB_PORT=5432
DB_NAME=myapp_dev
# .env.local — git-ignored, per-developer overrides + dev secrets
LOG_LEVEL=debug
DB_PASSWORD=dev-only-not-a-real-secret
.gitignore must include .env.local. Audit any .env* pattern: only ignore variants that hold secrets; commit the safe ones.
7. Dependency updates — Renovate (default), Dependabot (acceptable)
The problem: dependency updates accumulate until they hit a security advisory or a breaking version, then a week of catch-up is needed. Automate it.
Default: Renovate
renovate.json at the repo root:
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["config:recommended"],
"schedule": ["before 6am on Monday"],
"packageRules": [
{
"matchUpdateTypes": ["minor", "patch"],
"groupName": "minor + patch updates"
},
{
"matchPackageNames": ["go", "python", "node"],
"matchUpdateTypes": ["major"],
"automerge": false,
"labels": ["language-bump"]
}
],
"vulnerabilityAlerts": {
"enabled": true,
"labels": ["security"]
}
}
- Why Renovate: grouping rules, scheduled batches, broader ecosystem coverage (Go modules, Python, npm, Docker tags, GitHub Actions, Terraform).
- Group minor + patch updates into one weekly PR — review-bandwidth-friendly.
- Security updates land immediately — never queued.
- Major bumps stay separate, labeled, never auto-merged — they deserve a human read.
Acceptable: Dependabot
For tiny single-language repos where Renovate's flexibility is overkill, GitHub's built-in Dependabot is fine. Same pattern (security immediate, minor grouped, major labeled).
8. CI — GitHub Actions (default), act for local/free runs
The problem: GitHub Actions minutes aren't free once the included allowance is exceeded (or a payment/spending-limit issue blocks the account) — Docker-heavy jobs (multi-platform builds, image scans) burn through them fastest.
Default: GitHub Actions, workflow files under .github/workflows/,
triggered on push/pull_request as normal.
When Actions billing becomes a blocker (spending limit hit, no card on
file, or a deliberate "don't pay for CI" stance): run the same workflow
file locally via act instead of writing
a second pipeline. act reads .github/workflows/*.yml and runs each job
as a sibling Docker container, using a runner image
(catthehacker/ubuntu:act-latest covers most ubuntu-latest jobs) that
closely mirrors GitHub's actual runner — including Docker-in-Docker-style
builds, since that image ships the Docker CLI against the host daemon.
# .actrc — tracked, no secrets
-P ubuntu-latest=catthehacker/ubuntu:act-latest
--container-architecture=linux/amd64
# .secrets.example — tracked template; .secrets itself is gitignored
MY_TOKEN=
Wire it into the task runner so it's one command, not a memorized act
invocation:
ci:local:
desc: Run CI locally via act
cmds:
- test -f .secrets || (echo "Missing .secrets — cp .secrets.example .secrets" && exit 1)
- act push --secret-file .secrets --artifact-server-path .artifacts
- Switch the workflow's trigger to
workflow_dispatch-only if the goal is "never risk a billed run" rather than "have a free local option in addition to GitHub's" — pushing commits/tags then can't accidentally spin up a hosted runner;workflow_dispatchstays available from the Actions tab as a manual, opt-in escape hatch. --artifact-server-pathis required foractions/upload-artifact/actions/download-artifactto work between jobs locally — without it those calls silently no-op instead of erroring.- Secrets and repo variables come from
--secret-file/--var-file, not GitHub's secret store — gitignore the real file, commit a.exampletemplate (same shape as the.env/.env.localpattern in §6). - A tag-triggered job needs a synthesized event file, not just
act push—{"ref": "refs/tags/vX.Y.Z"}via-e event.jsonsetsgithub.ref/github.ref_namethe same way a real tag push would, which matters for anyif: startsWith(github.ref, 'refs/tags/v')gate or version string baked into an image tag. - A job that builds and pushes a Docker image to a registry running on
the same machine hits two more gotchas, in sequence:
- If that registry sits behind a Cloudflare Tunnel (or similar) whose
domain is only meaningful for remote access, pushing through it
from the same host that runs the registry can hit the tunnel's own
edge timeout on a multi-MB layer upload (Cloudflare's is ~100s) —
traffic that never needed to leave the machine. Make the registry
host a repo variable (
REGISTRY_HOST, default the real domain) and override it to the registry's local address (e.g.localhost:5000) for localactruns specifically. - Bypassing to
localhostthen fails withconnection refusedfrom inside the builder, even though the job's own container is host-networked underact—docker/setup-buildx-action's defaultdocker-containerdriver builds in a separate, isolated builder container with its own network namespace. Fix:driver-opts: network=hoston that action. - Whatever you use to observe the result, use the task runner's actual
exit code, not a wrapper's —
task ci:local:publish | tee log | tailreportstail's exit status, which is0even when the piped command failed. Check the real job output (or the exit code without piping through a second command) before calling a run green.
- If that registry sits behind a Cloudflare Tunnel (or similar) whose
domain is only meaningful for remote access, pushing through it
from the same host that runs the registry can hit the tunnel's own
edge timeout on a multi-MB layer upload (Cloudflare's is ~100s) —
traffic that never needed to leave the machine. Make the registry
host a repo variable (
- Trade-off, accept it deliberately: no automatic gate on push anymore
if triggers move to
workflow_dispatch-only. Running the local task before pushing is on the developer, not enforced (a pre-push git hook can close this gap if it becomes a real problem in practice). - Don't reimplement the pipeline as shell scripts instead.
actruns the actual workflow file — no second definition to drift out of sync with the first.
9. Agent instructions — AGENTS.md (source), CLAUDE.md (thin)
Files that brief coding agents on the repo. Add them once the repo has commands or conventions an agent cannot infer from the code.
AGENTS.mdis the single source. Tool-neutral (Codex, OpenCode, Cursor, Claude Code via import). Lives at the repo root.CLAUDE.mdstays thin:@AGENTS.mdplus only Claude-specific lines (hooks, slash commands, memory notes). Never duplicate content between the two.- Nested
AGENTS.mdin a subdirectory only when that package has its own commands or rules; the closest file wins. - Generated blocks (e.g. skill imports from a tool like
rsk) go in their own file or a delimited section, never hand-edited.
What belongs, in this order:
- One-paragraph purpose of the repo.
- Commands — build, test, lint, run, using the task runner names from section 4.
- Layout — top-level directories and what each owns.
- Conventions that are non-obvious — what a good engineer would still get wrong.
- Boundaries — always / ask first / never (publishing, migrations, secrets, generated files).
- Pointers to
docs/(ADRs, backlog) instead of copying them; seedocs-architectfor the snippet.
What does not belong: anything derivable from the code or git log, tutorials, full API docs, secrets, private details of other projects.
Keep it short (aim under ~150 lines). Every line should prevent a mistake; when an instruction stops earning its place, delete it. Treat it as code: review changes, and fix it when an agent gets something wrong because of it.
10. When to skip the whole thing
This skill is opinionated about adding tools, but the strongest opinion is don't add what you don't need.
- Single-language single-service project: skip the task runner (use native tooling), keep
mise/protofor version pinning if more than one dev exists. - Solo throwaway project:
.editorconfigand.gitignore. That's it. - Documentation-only repo:
.editorconfig,.gitignore, optional pre-commit for trailing whitespace. - Library / SDK with one entry point: language-native tooling + Renovate. No Task, no mise needed.
- Multi-language monorepo / multi-service compose stack: the full stack —
.editorconfig,.gitignore,mise.toml(or.prototools),Taskfile.yml,pre-commit-config.yaml,renovate.json,docker-compose.yaml,AGENTS.md.
Default to less. Add when the friction is real.