summaryrefslogtreecommitdiff
path: root/conformance/README.txt
diff options
context:
space:
mode:
authorJackson Moore <jacksonmoore@tuta.io>2026-09-03 16:41:35 +0200
committerJackson Moore <jacksonmoore@tuta.io>2026-09-03 16:41:35 +0200
commit6782384df0a9580b26e9418f0693ac3321dbf6f4 (patch)
tree5e148d9cb7424277e221d169e041e66ea381c6b1 /conformance/README.txt
Adds conformance ledger and fixtures
Diffstat (limited to 'conformance/README.txt')
-rw-r--r--conformance/README.txt73
1 files changed, 73 insertions, 0 deletions
diff --git a/conformance/README.txt b/conformance/README.txt
new file mode 100644
index 0000000..d341c3d
--- /dev/null
+++ b/conformance/README.txt
@@ -0,0 +1,73 @@
+CLEVER-F CONFORMANCE ASSETS
+
+PURPOSE
+
+These files are the Phase 1 conformance ledger and reference fixtures. They define checks before plugin implementation starts.
+
+FILES
+
+requirements.tsv
+One row represents one normative rule. The requirement identifier has the form CF-SSSS-NNN. SSSS is the specification section with punctuation removed. NNN is an ordinal inside that section.
+
+scenario-schema.json
+JSON Schema Draft 2020-12 contract for host-neutral fixtures.
+
+fixtures/reference-examples.json
+Scenarios transcribed from specification sections 11 and 15.
+
+fixtures/transition-fixtures.json
+Scenarios for cleanup and exact field-retention transitions.
+
+migemo-assets.txt
+Inventory and request for the three normative Migemo data sets.
+
+specification-observations.txt
+Traceability notes for source examples that require confirmation.
+
+phase-status.txt
+Completion and block status for affected implementation phases.
+
+LEDGER COLUMNS
+
+requirement_id
+Stable identifier for one normative rule.
+
+strength
+REQUIRED maps to SHALL and normative declarative behavior. RECOMMENDED maps to SHOULD. OPTIONAL maps to MAY.
+
+source
+Specification section that owns the rule.
+
+rule
+Host-neutral statement of the rule.
+
+leaf_scope
+One leaf scope from implementation-strategy.txt section 2.
+
+component_owner
+One responsibility component from implementation-strategy.txt section 3.
+
+planned_check
+A concrete check for a later unit, integration, adapter, or conformance test.
+
+fixture_ids
+Initial scenario coverage. A hyphen means that the planned check will become a fixture during its implementation phase.
+
+SCENARIO CONVENTIONS
+
+- Positions use one-based lines and one-based byte columns.
+- Step indexes, packet indexes, event indexes, and time-value indexes use zero-based JSON array indexes.
+- Buffer lines contain decoded editor text. effective_encoding selects the byte representation used by the host text view.
+- Raw input packets store decimal byte values.
+- An omitted configuration key uses the specification default.
+- Resource identities are stable symbolic test identities.
+- Operations in each expected list use observation order.
+- A state snapshot is a partial structural assertion. Omitted state fields are outside that snapshot assertion.
+- retained_fields and cleared_fields name transition fields that a test must compare with the preceding state.
+- Events run after the action transition that caused them. A standalone event uses the state in given or in the latest set_state step.
+- final_buffer and action outcome buffer_lines record operator effects.
+- dot_payload records the effective descriptor and resolved target.
+
+COVERAGE RULE
+
+Every ledger row has one leaf scope, one component owner, and one planned check. Initial fixture identifiers connect required interactions and transition checks to declarative scenarios. Later phases can add fixture identifiers without changing requirement identifiers.