Style Guide

Code style, naming conventions, and repository standards.

Go

  • Follow the Effective Go style guide.
  • Format all code with gofmt (task fmt:code).
  • Run go vet before committing (task lint:vet).
  • Prefer table-driven tests.
  • Error strings are lowercase and do not end with punctuation.

Taskfile

  • All task names are verb:subject — no bare verbs.
  • The default task runs task --list.
  • Use start/stop for local services — never run, up, down, or serve.
  • Aggregate tasks use :all as the subject (build:all, test:all).
  • Every command runs inside a Docker container.

Documentation

  • Page titles come from front matter — no in-document H1.
  • No emoji in documentation.
  • Follow Diataxis: tutorials teach, how-tos solve tasks, reference informs, explanation gives background.

Git

  • Follow Semantic Git.
  • Commit messages are lowercase after the prefix.
  • PR titles mirror the commit prefix format.

Versioning

  • Semantic Versioning for releases.
  • Update CHANGELOG.md under [Unreleased] as you work.
  • Releases cut a new version header in CHANGELOG.md.