Michael Chus
558f6e5601
CLAUDE.md and AGENTS.md (now a symlink) shrink to a pointer at the bootstrap, which absorbs the rule-editing instructions. The two identical per-tool templates merge into rules/ai/AGENT.template.md. README drops the read path duplicated from the bootstrap. The web-visual-baseline starter CSS/HTML duplicated assets/view.css and is removed in favor of the vendored assets. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
37 lines
1.2 KiB
Markdown
37 lines
1.2 KiB
Markdown
# 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.
|
|
|
|
Agents start at `AGENT-BOOTSTRAP.md` — it defines the read path, always-on contracts,
|
|
and the task router. Nothing in this README duplicates it.
|
|
|
|
## 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/AGENT.template.md — template for new projects; copy as both CLAUDE.md and AGENTS.md
|
|
scripts/lint.sh — consistency checks (router coverage, broken links)
|
|
```
|
|
|
|
## Project Setup
|
|
|
|
Each project needs:
|
|
- `bible/` — this submodule
|
|
- `bible-local/` — project-specific architecture (data model, API, ADL)
|
|
- `CLAUDE.md` + `AGENTS.md` — copies of `rules/ai/AGENT.template.md` pointing agents to the bootstrap
|
|
|
|
See `rules/patterns/go-project-bible/contract.md` for what goes in `bible-local/`.
|