Skip to content

paper-board Engineering Standards

Canonical engineering standards for all paper-board service repositories. Service READMEs link here.

FileRead when
go-coding-conventions.mdWriting or reviewing Go code
go-service-layout.mdCreating a new service or scaffolding directory layout
http-api-conventions.mdDesigning REST endpoints, request/response shapes, errors
database-conventions.mdSchema design, migrations, naming, indexes
testing.mdWriting tests, choosing test type, mocking policy
configuration.mdEnv vars, config loading, secrets
observability.mdLogging, metrics, tracing, correlation IDs
error-handling.mdError wrapping, error types, gRPC/HTTP error mapping
build-release.mdDockerfile, CI, versioning, release flow