# 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

```bash
# 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; contains the full contract router
rules/patterns/<topic>/    — one contract.md per topic (plus optional README.md with examples)
rules/ai/claude/           — CLAUDE.template.md for new projects
rules/ai/codex/            — AGENTS.template.md for new projects
scripts/lint.sh            — consistency checks (router coverage, broken links)
```

The list of contracts is not duplicated here. The single source of truth for what exists
and when to read it is the router in `AGENT-BOOTSTRAP.md`.

## 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/`.