Files
best-practices/BESTPRACTICES.md
Paul O'Reilly 3efe153ca1 Populate best practices from claude-foundations
Migrates 20 topic files from claude-foundations/best-practices/ to this
standalone repo. Adds BESTPRACTICES.md index, CLAUDE.md conventions, and
updated README.md. Container agents clone this repo to /best-practices.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-28 17:46:13 +13:00

2.7 KiB

Best Practices Index

Generalised best practices extracted from real project work via the /distill-best-practices skill. Each topic file is self-contained — read only the files relevant to the current project.

Topics

  • Validation & Deployment — Validate locally, deploy once; full-chain testing; pre-flight checks
  • Security Architecture — Server boundary rule: no credential crosses to the client; proxy + identity mapping pattern; defense in depth; anti-patterns
  • Secrets Management — SOPS + age, credential handling, file naming, encryption gotchas
  • Git & Source Control — Commit practices, GitOps workflows, remote conventions
  • Kubernetes Patterns — Volume mounts, deployment strategies, naming, bootstrap ordering
  • Helm Charts — Schema validation, version verification, values structure
  • Ansible — Inventory, templates, idempotency, credential safety
  • Scripting — Shell conventions, verification scripts, idempotency, colour output
  • Documentation Standards — CLAUDE.md, MEMORY.md, FUTURE.md, README.md structure and tiered memory
  • Milestones & Reflections — Milestone workflow, verification, reflection process
  • Debugging Methodology — Systematic diagnosis, full-chain testing, common pitfalls
  • Claude Code Skills — Skill authoring, context injection, tool restrictions
  • Linting & Formatting — Tool choices per language, PostToolUse hook, pre-commit integration, formatter contract
  • Spec-Driven Development — Spec structure, requirement numbering, test-first workflow, context tiers, anti-patterns
  • Test-Driven Development — Edge case discovery, property-based testing, mutation testing, AI agent testing patterns, test architecture
  • Networking & Infrastructure — nftables safety, systemd socket activation, Docker forwarding, TLS SNI vs Host header, wildcard certs
  • Docker UID Matching — UID wrapper entrypoint for mounted volumes, gosu pattern, when to use vs K8s securityContext
  • Database Selection — SQLite is not a production database; always use PostgreSQL for services with FQDNs, multiple consumers, or concurrent access
  • Docker — gosu PID 1, GIT_SSH_COMMAND scope, slim image health checks, buildx local images, default users, TTY flags, UID resolution
  • Octopus Process Templates — OCL syntax, step template references, channel scoping, parameters, versioning, Platform Hub patterns