mchus/bible
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Deduplicate README structure list and add consistency lint

Browse Source 
README no longer mirrors the contract list; the bootstrap router is the
single source of truth. scripts/lint.sh checks router coverage, dead
bootstrap references, and machine-local absolute paths.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Michael Chus
2026-06-12 09:44:40 +03:00
parent c8f072661f
commit 80e87cdc1f
2 changed files with 42 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -33,26 +33,16 @@ git submodule update --remote bible
## Structure ## Structure
``` ```
AGENT-BOOTSTRAP.md — first file agents should read AGENT-BOOTSTRAP.md — first file agents should read; contains the full contract router
rules/patterns/ — shared engineering rule contracts rules/patterns/<topic>/ — one contract.md per topic (plus optional README.md with examples)
go-logging/ — slog, server-side only rules/ai/claude/ — CLAUDE.template.md for new projects
go-database/ — cursor safety, soft delete, GORM, N+1 rules/ai/codex/ — AGENTS.template.md for new projects
go-api/ — REST conventions, error format, status codes scripts/lint.sh — consistency checks (router coverage, broken links)
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
``` ```
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 ## Project Setup
Each project needs: Each project needs:

34
scripts/lint.sh Executable file
View File

@@ -0,0 +1,34 @@
#!/bin/sh
# Consistency checks for the rules library. Run from the repo root: sh scripts/lint.sh
set -u
fail=0
# 1. Every pattern directory must be reachable from the bootstrap router.
for dir in rules/patterns/*/; do
name=$(basename "$dir")
if ! grep -q "$name" AGENT-BOOTSTRAP.md; then
echo "FAIL: rules/patterns/$name is not mentioned in AGENT-BOOTSTRAP.md"
fail=1
fi
done
# 2. Every bible/... path mentioned in the bootstrap must exist in the repo.
for ref in $(grep -o 'bible/rules/patterns/[a-z-]*/contract\.md' AGENT-BOOTSTRAP.md | sort -u); do
path=${ref#bible/}
if [ ! -f "$path" ]; then
echo "FAIL: AGENT-BOOTSTRAP.md references missing file $path"
fail=1
fi
done
# 3. No machine-local absolute paths in committed markdown.
if grep -rn '/Users/' --include='*.md' . --exclude-dir=.git; then
echo "FAIL: machine-local absolute paths found (see above)"
fail=1
fi
if [ "$fail" -eq 0 ]; then
echo "OK: all checks passed"
fi
exit "$fail"