46 lines
1.6 KiB
Markdown
46 lines
1.6 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.
|
|
|
|
## 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
|
|
|
|
```
|
|
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
|
|
```
|
|
|
|
## Project Setup
|
|
|
|
Each project needs:
|
|
- `bible/` — this submodule
|
|
- `bible-local/` — project-specific architecture (data model, API, ADL)
|
|
- `CLAUDE.md` + `AGENTS.md` — point agents to both
|
|
|
|
See `rules/ai/claude/CLAUDE.template.md` for a ready-made template.
|
|
See `rules/patterns/go-project-bible/contract.md` for what goes in `bible-local/`.
|