oy/openyield
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 42 Wiki Activity

docs(P00): add oy-spec-template.md — blank skeleton for fresh milestone cycles

Browse Source 
OY-specific template the PO copies to .ciagent/oy/oy-spec (no .md) when
starting a fresh milestone cycle. Pre-fills the locked baseline that does not
change between milestones (Six Principles §3, Constraints §5, Lexicon §6,
REQ-001..REQ-021 locked-vision rows in §4, Rules + Commit convention blocks).
Clears the per-milestone content the PO must fill (§1 Objective, §2 Vision
source locked-sections, §4 acceptance criteria, §4 new REQ-022+ rows, §7
Milestone intent, §8 Open questions, §9 Changelog).

Each placeholder is a <!-- TODO --> comment so the PO can grep for unfilled
slots. The header comment block explains what is pre-filled vs what the PO
fills, and points to oy-state §2 for the current max REQ-ID before adding new
rows.

Lives at .ciagent/oy/oy-spec-template.md (.md extension because it is a
reference file the PO reads in an editor, not ingested by the ciagent — the
working oy-spec / oy-state keep the bare-stem convention for ingestion).

---ci---
phase: 0
milestone: v0.6
status: execute
project: oy
---/ci---
This commit is contained in:
cloudinit-bot
2026-08-18 23:23:09 +00:00
parent 9e5e98f22e
commit 2c0e953881
1 changed files with 176 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.ciagent/oy/oy-spec-template.md
+176
View File
@@ -0,0 +1,176 @@
<!--
OpenYield Spec Template
=======================
Copy this file to `.ciagent/oy/oy-spec` (no .md extension) when starting a
fresh milestone cycle. Then fill every `<!-- TODO -->` placeholder and commit
with a `docs(spec):` Conventional Commit (see the commit convention block at
the bottom of this file).
What is pre-filled (do NOT edit unless the locked baseline itself changes):
- §3 Principles [locked] (Six Principles)
- §5 Constraints (project invariants)
- §6 Lexicon [locked] (banned terms + replacements)
- §4 REQ-001..REQ-021 (locked-vision baseline rows — acceptance criteria
still need filling on first use)
- Rules + Commit convention blocks
What the PO must fill per milestone:
- §1 Objective
- §2 Vision source (locked sections list)
- §4 acceptance criteria for every REQ the milestone implements
- §4 new REQ-NNN rows for milestone-specific additions (continuing the ID
sequence from the last shipped REQ — check `oy-state` §2 for the current
max REQ-ID)
- §7 Milestone intent (current shipped, next target, out-of-scope)
- §8 Open questions for the ciagent
- §9 Changelog (one row per spec revision)
-->
# OpenYield Spec — spec-vN
Owner: <product owner>
Status: draft
Ingested as: oy-spec
> This is the **only** document the product owner (PO) sends to the ciagent for
> implementation. The ciagent consumes it to regenerate PROJECT.md,
> REQUIREMENTS.md, and ARCHITECTURE.md. Nothing else is read from upstream.
>
> In return the ciagent maintains **one** sibling file — `oy-state` — that tells
> the PO what exists, what's locked, what's deferred, and what drift exists
> between this spec and the shipped code. Read `oy-state` before editing
> `oy-spec`; it prevents re-proposing shipped or explicitly-deferred REQs.
>
> `oy-spec` and `oy-state` are the only two docs that cross the PO<->ciagent
> boundary. All other `.ciagent/oy/*.md` files are ciagent-internal working
> memory — do not edit them.
## 1. Objective
<!-- TODO: <=3 sentences — what the mesh is and who it serves -->
## 2. Vision source
- Document: Vision v3.0 (22 sections)
- Locked commitments (non-amendable sections):
<!-- TODO: list section numbers that are non-amendable -->
## 3. Principles [locked]
1. Real value
2. Sustainability
3. Mission-lock
4. Openness
5. Ownership
6. Self-service
<!-- Do not edit — the ciagent enforces these as REQ-001. -->
## 4. Requirements
<!-- Each row: ID | Title | Vision § | Priority | Locked? | Acceptance criteria
REQ-001..REQ-021 are the locked-vision baseline — fill their acceptance
criteria on first use, do not change their Locked? column without an
explicit §9 changelog override.
Add new milestone-specific REQs below REQ-021, continuing the ID sequence
from the last shipped REQ (check `oy-state` §2 for the current max). -->
| ID | Title | Vision § | Priority | Locked? | Acceptance criteria |
|----|-------|----------|---------|---------|---------------------|
| REQ-001 | Enforce Six Principles | §2 | High | yes | <!-- TODO: criteria --> |
| REQ-002 | Fee ceiling 0.1% / floor 0.01% / 1-Grain min | §18 | High | yes | <!-- TODO: criteria --> |
| REQ-003 | Bloom from real production only (Root Basket) | §6 | High | yes | <!-- TODO: criteria --> |
| REQ-004 | 9 Watchers, 6-of-9 quorum | §7 | High | yes | <!-- TODO: criteria --> |
| REQ-005 | Four Freeholder signals | §9.1 | High | yes | <!-- TODO: criteria --> |
| REQ-006 | Standing anti-gaming formula | §9.2 | High | yes | <!-- TODO: criteria --> |
| REQ-007 | FCFS processing | §15 | High | yes | <!-- TODO: criteria --> |
| REQ-008 | OY Chain (Layer 1) | §7 | High | yes | <!-- TODO: criteria --> |
| REQ-009 | Satellite chains (Layer 2) | §7 | Medium | no | <!-- TODO: criteria --> |
| REQ-010 | Exit layer (Layer 3) | §7 | Medium | no | <!-- TODO: criteria --> |
| REQ-011 | Three Councils with Mission Lock | §19 | High | yes | <!-- TODO: criteria --> |
| REQ-012 | Lexicon compliance | §3 | High | yes | <!-- TODO: criteria --> |
| REQ-013 | Bread unit with scale | §4 | High | yes | <!-- TODO: criteria --> |
| REQ-014 | Three pools of storage | §5 | High | yes | <!-- TODO: criteria --> |
| REQ-015 | Window primitive | §10 | High | no | <!-- TODO: criteria --> |
| REQ-016 | Nine Stand types | §11 | Medium | yes | <!-- TODO: criteria --> |
| REQ-017 | Guilds with free Hand-Passes | §12 | Medium | yes | <!-- TODO: criteria --> |
| REQ-018 | Four-tier Partner Spectrum | §13 | Medium | no | <!-- TODO: criteria --> |
| REQ-019 | Six bearers via Unified Bearer Layer | §14 | Medium | yes | <!-- TODO: criteria --> |
| REQ-020 | Six Pacts | §16 | Medium | no | <!-- TODO: criteria --> |
| REQ-021 | Mesh Bond Market with 8% cap | §17 | Medium | yes | <!-- TODO: criteria --> |
| <!-- TODO: REQ-022 --> | <!-- TODO: title --> | <!-- TODO: vision § --> | <!-- TODO: priority --> | <!-- TODO: locked? --> | <!-- TODO: criteria --> |
| <!-- TODO: REQ-023 --> | <!-- TODO: title --> | <!-- TODO: vision § --> | <!-- TODO: priority --> | <!-- TODO: locked? --> | <!-- TODO: criteria --> |
## 5. Constraints
- 14 modular components, 6 cross-component interfaces
- Mission Lock non-amendable
- Lexicon firewall: banned terms = bank, deposit, interest, yield, currency, dollar/euro, account, savings, depositor
- Skeleton-first until mainnet gate (D-020 pattern)
- Zero Go deps except GRILL-approved runtime exceptions
- Coverage >=80% on shipped packages
- Multi-project mode active; project slug = `oy`
## 6. Lexicon [locked]
- Banned: bank, deposit, interest, yield, currency, dollar, euro, account, savings, depositor
- Required replacements: account -> Reach, deposit -> receive-asset, interest -> coupon, yield -> bloom, currency -> asset
## 7. Milestone intent
- Current shipped: <!-- TODO: last shipped milestone tag, e.g. v0.6 (v0.5.6) — COMPLETE -->
- Next: <!-- TODO: next milestone target — one paragraph + the REQ-IDs it draws from -->
- Out-of-scope this milestone:
<!-- TODO: list — cross-reference `oy-state` §4 (deferred) to avoid re-proposing -->
## 8. Open questions for the ciagent
<!-- TODO: bulleted; the ciagent logs assumptions if unanswered at autonomy=full -->
## 9. Changelog
<!-- Every spec revision MUST be a `docs(spec):` commit (see commit convention
block below). One row per revision. -->
| Spec-v | Date | Commit (docs(spec):) | What changed | REQs affected |
|--------|------|----------------------|--------------|---------------|
| v1 | <!-- TODO: date --> | <!-- TODO: docs(spec): initial spec --> | <!-- TODO: summary --> | <!-- TODO: REQ-IDs --> |
---
## Rules (PO <-> ciagent contract)
- **One document each way.** No slides, sidecar notes, or direct edits to
generated docs. If you want to change product intent, edit `oy-spec`; if you
want to know what the ciagent did, read `oy-state`.
- **Every REQ the ciagent implements must appear in §4 with acceptance
criteria.** Vague criteria -> vague implementation.
- **Mark a REQ `[locked]`** only if a future spec revision must not change it
without an explicit override line in §9. Locked REQs map to const firewalls
the ciagent defends with regression tests (listed in `oy-state` §3).
- **The ciagent regenerates `oy-state` at every milestone ship AND at P0 of the
next milestone if `oy-spec` changed since the last `oy-state`.** `oy-state`
is authoritative for "what exists"; PROJECT.md is internal working memory.
- **Before proposing a new REQ in §4, grep `oy-state` §2 (coverage) and §4
(deferred).** Re-proposing an existing or explicitly-deferred REQ is a no-op
and will be flagged as drift in the next `oy-state` §5.
- **When §4 or §6 change,** the ciagent regenerates PROJECT/REQUIREMENTS and
flags drift. When §3/§5 only change, no regeneration is needed.
## Commit convention (mandatory for `oy-spec`)
- Every commit that modifies `oy-spec` MUST use a Conventional Commit message:
```
docs(spec): <imperative summary <=72 chars>
<optional body: what changed in §4/§6 and why; >=1 line per REQ affected>
```
- Examples:
```
docs(spec): add REQ-046 governance spam deposit (§4)
Opens REQ-046 per oy-state §4 deferred item "governance spam deposit".
Acceptance: proposal deposit >= 1 Loaf, slashable on spam.
```
```
docs(spec): lock REQ-002 fee ceiling — overrideable only via §9
REQ-002 fee covenant locked per vision §18; any future change requires an
explicit §9 changelog override line.
```
- The ciagent will **REJECT** any `oy-spec` commit whose subject does not match
`docs(spec): ...`. This makes spec changes grep-able and ties each
implementation milestone back to the spec revision that authorized it (via
the §9 Changelog row referenced in the commit body).
- **No squash merges, `fixup!`, or empty commits** for `oy-spec`. Every edit
is a real `docs(spec):` commit on the default branch.