Skip to content

Commit c0121ba

Browse files
committed
add cross-repository compatibility matrix
1 parent dd2ae82 commit c0121ba

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

docs/governance/COMPATIBILITY.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# AxonOS Cross-Repository Compatibility Matrix
2+
3+
Status: Draft 0.1.0
4+
Authority: AxonOS Standard
5+
Date: 2026-05-22
6+
7+
This document defines the compatibility surface between AxonOS repositories.
8+
9+
## Repository Matrix
10+
11+
| Repository | Role | Current Version | Status |
12+
|---|---|---:|---|
13+
| axonos-standard | Normative standard authority | 0.1.x | Canonical |
14+
| axonos-rfcs | Engineering RFC process | draft/active/final | Normative when finalized |
15+
| axonos-consent | Consent state-machine reference crate | 0.3.x | Pre-clinical reference |
16+
| axonos-sdk | Application-facing SDK | 0.3.x | Requires protocol sync |
17+
| axonos-kernel | Real-time kernel substrate | 0.2.x | Research-grade kernel substrate |
18+
| axonos-swarm | Distributed timing research | 0.2.x | Experimental |
19+
| axon-bci-gateway | Acquisition-boundary fork | 1.0.0 | Non-safety acquisition boundary |
20+
21+
## Interface Authorities
22+
23+
| Interface | Source of Truth | Implementing Repositories |
24+
|---|---|---|
25+
| Consent state machine | AxonOS Standard + consent RFC | axonos-consent, axonos-sdk |
26+
| Intent observation ABI | AOS-0007 / RFC intent ABI | axonos-sdk, axonos-kernel |
27+
| IPC timing contract | AOS-0008 | axonos-kernel |
28+
| Neural intent processing | AOS-0012 | future classifier pipeline |
29+
| Acquisition boundary | AOS-0001 mapping | axon-bci-gateway |
30+
| Distributed timing | RFC / experimental | axonos-swarm |
31+
32+
## Compatibility Rules
33+
34+
1. A repository MUST NOT claim conformance to an AOS artifact unless required evidence exists.
35+
2. A repository MUST declare protocol and ABI versions visibly.
36+
3. Experimental repositories MUST be labelled experimental.
37+
4. Gateway repositories MUST NOT claim kernel-level real-time, clinical, or regulatory status.
38+
5. Consent and SDK versions MUST be synchronized before safety-critical claims.
39+
6. Kernel and SDK ABI changes MUST be reflected in RFCs and this matrix.
40+
41+
## Current Known Gaps
42+
43+
| Gap | Severity | Required Action |
44+
|---|---|---|
45+
| Consent protocol version authority is fragmented | High | Add explicit consent protocol version matrix |
46+
| SDK / consent compatibility not yet frozen | High | Add cross-repo ABI tests |
47+
| Independent review trail not yet visible | High | Add CODEOWNERS and Reviewed-by process |
48+
| Claim registry not yet enforced by CI | Medium | Add claim verification tooling |
49+
| SBOM generation not yet org-wide | Medium | Add cargo-sbom / dependency inventory |
50+
| Security disclosure policy not yet centralized | Medium | Add org-level security policy |
51+
52+
## Release Blocking Rule
53+
54+
A release that changes an ABI, wire format, consent event, or timing claim MUST update this matrix in the same pull request or commit.

0 commit comments

Comments
 (0)