You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
V48 (specification-only): Require FAMILIARIZATION.md stay current with changes
Add BITCODE_SPECIFYING.md §16.3.1 law that the repository familiarization map
must update with structural changes (package families, hierarchy, experience
paths, routes). Mirror the duty in AGENTS.md, FAMILIARIZATION maintenance, and
V48 notes; tie it to Complete Implementation Derivability commit discipline.
Copy file name to clipboardExpand all lines: AGENTS.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
- Never explicitly version source code without direct instruction. Source code is always implicitly versioned to the active Bitcode canon and current gate; routes, file names, CSS files, constants, classes, API paths, tests, and implementation identifiers must be written in-place as the single current Bitcode system. Do not introduce names such as `api/v1`, `v27-*`, `first-gate-*`, `wip-*`, or similar version/gate/work-in-progress source constructs unless explicitly directed for a bounded compatibility artifact.
5
5
- Do not consider any legacy code. All legacy code is located under `_legacy/`.
6
6
-**Source layout and modularity (required):** follow `internal-docs/BITCODE_SOURCE_LAYOUT.md` and `uapi/components/README.md`. Dependency direction is `packages` → Bitcode/Shadcn adapters → experience components → thin `uapi/app` page shells. Seven experiences (Marketing, Packs, Reads, Deposits, Docs, Conversations, Auxillaries) plus `Shadcn*` / `Bitcode*` bases. New components live in **named directories** (`ComponentName/ComponentName.tsx` — not `index.tsx`) with co-located `hooks/`, `styles/`, `__tests__/`. Prefer packages for pure domain logic. Product run language is **Pipeline**; BTD ledger language is **journal**. **Do not reintroduce Terminal** (`app/terminal` is deleted; no `/terminal` product route).
7
-
-**Codebase familiarization:** read `FAMILIARIZATION.md` for the package catalog, uapi request path, and the inheritance pattern `*-generics` primitives → `generic-*` base implementations → product specializations (agents, tools, pipelines, prompts, LLMs).
7
+
-**Codebase familiarization:** read `FAMILIARIZATION.md` for the package catalog, uapi request path, and the inheritance pattern `*-generics` primitives → `generic-*` base implementations → product specializations (agents, tools, pipelines, prompts, LLMs).**Keep `FAMILIARIZATION.md` up to date with changes** (`BITCODE_SPECIFYING.md` §16.3.1): any change that moves package families, inheritance hierarchy, experience entry paths, product routes, or other structure the guide teaches must update `FAMILIARIZATION.md` in the same change set (accurate short section edits preferred).
8
8
- Highest caliber software engineering crafstmanship (maintainibility, abstractions, architectures, naming, patterns, comments, documentation, structures, algorithmic and data flow designs, UI/UX, etc.), correctness (specification and implementation precision, reliability, completeness, boundaried, scoped, encapsulated, etc.), and auditable (totalistic proofs systems from static code, build time, runtime, etc. etc. as is Bitcode, tests from unit, integration, E2E, linting and building, etc.). Every non-trivial file carries a top-of-file overview comment; obey SRP and DRY; co-locate unit tests with components when practical.
9
9
- Do not push work directly to `main`. Create a version base branch for each draft target, such as `version/v28`, then create scoped gate branches from that version branch. Gate branches must be prefixed with the gate number, such as `v28/gate-3-read-fit-workflow` or `v28/gate-8-promotion-proof`. Pull-request each closed gate back into the version branch. Pull-request the version branch into `main` only when all gates are closed and the version is formally promoted as canon. The default branch is protected by the `Bitcode Core Contributions` ruleset and requires pull requests plus verified signatures.
10
10
- Gate pull request titles must begin with the uppercase version and gate prefix, followed by a concise topical title, for example `V29 Gate 5: AssetPack Disclosure Rights And Preview Depth`. Version-promotion pull requests must begin with the uppercase version and name canonical promotion.
0 commit comments