Michael Chus
b30b7ee739
- rules/patterns/go-project-bible/contract.md: required files, ADL format, runtime-flows rules, what not to duplicate, how to keep current - README.md: rewritten to reflect actual repo purpose and structure Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1.5 KiB
1.5 KiB
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
# 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
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 submodulebible-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/.