Bible

Shared engineering rules library for Go web projects.

Add as a git submodule to any project — agents (Claude, Codex) will read the rules automatically.

Agent Read Path

Agents should not read the whole submodule by default.

Start here:

1. bible/AGENT-BOOTSTRAP.md
2. bible-local/README.md
3. Only the relevant files in bible-local/architecture/, bible-local/decisions/, and bible/rules/patterns/...

The bootstrap file contains:

• the always-on core contracts
• a router from task type to relevant contracts
• the default rule to skip unrelated contracts

Usage

# Add to a project
git submodule add https://git.mchus.pro/mchus/bible.git bible

# Update to latest rules
git submodule update --remote bible

Structure

AGENT-BOOTSTRAP.md      — first file agents should read
rules/patterns/          — shared engineering rule contracts
  go-logging/            — slog, server-side only
  go-database/           — cursor safety, soft delete, GORM, N+1
  go-api/                — REST conventions, error format, status codes
  go-background-tasks/   — Task Manager pattern, polling
  go-code-style/         — layering, error wrapping, startup sequence
  go-project-bible/      — how to write and maintain a project bible
  bom-decomposition/     — one BOM row to many component/LOT mappings
  import-export/         — CSV Excel-compatible format, streaming export
  table-management/      — toolbar, filtering, pagination
  modal-workflows/       — state machine, htmx pattern, confirmation
  forms-validation/      — validation, multi-step flows
  controls-selection/    — buttons, checkboxes, segmented filters
rules/ai/claude/
  CLAUDE.template.md     — base CLAUDE.md template for new projects
rules/ai/codex/
  AGENTS.template.md     — base AGENTS.md template for new projects

Project Setup

Each project needs:

• bible/ — this submodule
• bible-local/ — project-specific architecture (data model, API, ADL)
• CLAUDE.md + AGENTS.md — point agents to the bootstrap file and to bible-local/

See rules/ai/claude/CLAUDE.template.md for a ready-made template. See rules/ai/codex/AGENTS.template.md for a ready-made Codex template. See rules/patterns/go-project-bible/contract.md for what goes in bible-local/.