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

Clarify Gitea workflow and ban AI-style unicode markers

Browse Source
This commit is contained in:
Michael Chus
2026-04-22 20:47:27 +03:00
parent 1d89a4918e
commit 472b3e10d9
3 changed files with 53 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
rules/patterns/go-project-bible/contract.md
View File

@@ -16,29 +16,29 @@ Every project bible must have these files:
```
bible-local/
README.md — index: what files exist and what each covers
README.md - index: what files exist and what each covers
architecture/
system-overview.md — what the product does, active scope, non-goals
data-model.md — domain entities, DB tables, naming conventions
api-surface.md — all HTTP endpoints with methods and response shape
runtime-flows.md — key mutation flows, invariants, critical rules
system-overview.md - what the product does, active scope, non-goals
data-model.md - domain entities, DB tables, naming conventions
api-surface.md - all HTTP endpoints with methods and response shape
runtime-flows.md - key mutation flows, invariants, critical rules
decisions/
README.md — ADL format explanation
YYYY-MM-DD-topic.md — one file per architectural decision
README.md - ADL format explanation
YYYY-MM-DD-topic.md - one file per architectural decision
```
Optional (add when relevant):
```
architecture/
ui-information-architecture.md — page structure, navigation, UI invariants
ui-information-architecture.md - page structure, navigation, UI invariants
docs/
INTEGRATION_GUIDE.md — external system integration (formats, protocols)
INTEGRATION_GUIDE.md - external system integration (formats, protocols)
```
## system-overview.md Rules
- List what is **in scope** and what is **explicitly out of scope**.
- Out of scope section prevents scope creep — update it when you reject a feature.
- Out of scope section prevents scope creep; update it when you reject a feature.
- Include tech stack and local run command.
## data-model.md Rules
@@ -63,7 +63,7 @@ This is the most important file. Document flows that are **easy to break**:
- Event/time source priority rules
- Deduplication logic
- Cross-entity side effects (e.g. removing a component affects asset status)
- Anything that caused a bug or regression — add a "DO NOT reintroduce" note
- Anything that caused a bug or regression: add a "DO NOT reintroduce" note
Format each flow as a numbered list of steps, not prose.
@@ -94,19 +94,20 @@ What this means going forward. What is now forbidden or required.
```
- One decision per file, named `YYYY-MM-DD-short-topic.md`.
- When a decision is superseded, add `superseded by` to the old file's status — do not delete it.
- When a decision is superseded, add `superseded by` to the old file's status; do not delete it.
- Record the decision **in the same commit** as the code that implements it.
## What NOT to Put in bible-local/
- Generic rules (CSV format, logging, pagination) → these are in `bible/rules/patterns/`
- Work-in-progress notes, TODO lists → use issues or a separate `docs/` folder
- Generic rules (CSV format, logging, pagination) -> these are in `bible/rules/patterns/`
- Work-in-progress notes, TODO lists -> use issues or a separate `docs/` folder
- Duplicate of what is already in code (don't restate what the code clearly shows)
- Speculative future architecture — document what exists, not what might exist
- Speculative future architecture: document what exists, not what might exist
## Keeping the Bible Current
- Update `bible-local/` in the **same commit** as the code change it describes.
- If you change a flow, update `runtime-flows.md` in the same PR.
- If a section becomes outdated, fix or delete it — stale docs are worse than no docs.
- If a section becomes outdated, fix or delete it; stale docs are worse than no docs.
- Bible files are in **English only**.
- Do not use em dash in Bible files; prefer ASCII punctuation such as `-`, `:`, or `;` depending on the sentence.