go-store/CODEX.md
Virgil adc463ba75
All checks were successful
Security Scan / security (push) Successful in 9s
Test / test (push) Successful in 1m36s
docs(ax): add Codex conventions bridge
Co-Authored-By: Virgil <virgil@lethean.io>
2026-03-30 15:16:16 +00:00

883 B

CODEX.md

This repository uses the same working conventions described in CLAUDE.md. Keep the two files aligned.

AX Notes

  • Prefer descriptive names over abbreviations.
  • Public comments should show real usage with concrete values.
  • Keep examples in UK English.
  • Do not add compatibility aliases; the primary API names are the contract.
  • Preserve the single-connection SQLite design.
  • Verify with go test ./..., go test -race ./..., and go vet ./... before committing.
  • Use conventional commits and include the Co-Authored-By: Virgil <virgil@lethean.io> trailer.

Repository Shape

  • store.go contains the core store API and SQLite lifecycle.
  • events.go contains mutation events, watchers, and callbacks.
  • scope.go contains namespace isolation and quota enforcement.
  • docs/ contains the package docs, architecture notes, and history.