|
1 | | -# Resolution Log |
| 1 | +# RESOLUTION — Protocol-Commons |
| 2 | +*Lifecycle log for canonical verbs & schemas.* |
2 | 3 |
|
3 | | -This file tracks all lifecycle changes to CommandLayer verbs and schemas. |
4 | | -It is the **single source of truth** for why something was added, deprecated, or removed. |
5 | | -Every entry must be documented here to maintain transparency and trust. |
| 4 | +This file tracks **every** lifecycle decision for Protocol-Commons: |
| 5 | +verb additions, corrections, deprecations, and removals. |
6 | 6 |
|
7 | | ---- |
8 | | - |
9 | | -## Format |
10 | | - |
11 | | -Each entry should include: |
12 | | - |
13 | | -- **Date** — When the decision was made. |
14 | | -- **Verb(s)** — Affected canonical verb(s) |
15 | | -- **Action** — Added, Deprecated, Replaced, or Removed. |
16 | | -- **Reason** — Short explanation (ecosystem need, duplication, ambiguity, etc.). |
17 | | -- **Resolution** — The final decision (what replaces it, if anything). |
18 | | -- **Maintainers** — Who approved the change. |
| 7 | +If a change is **not** documented here, it is **not** considered valid. |
19 | 8 |
|
20 | 9 | --- |
21 | 10 |
|
22 | | -## Example Entries |
| 11 | +## Entry Requirements |
23 | 12 |
|
24 | | -### 2025-09-15 — Verb Addition |
25 | | -- **Verb(s):** `stream` |
26 | | -- **Action:** Added |
27 | | -- **Reason:** Needed for continuous broadcast use cases (audio/video agents). |
28 | | -- **Resolution:** Accepted as a **commercial** verb |
29 | | -- **Maintainers:** @ayden |
| 13 | +- **Date** — final decision date |
| 14 | +- **Verb(s)** — affected canonical verbs |
| 15 | +- **Action** — Added · Deprecated · Replaced · Removed |
| 16 | +- **Reason** — interoperability, security, redundancy, etc. |
| 17 | +- **Resolution** — final state (including replacements, if any) |
| 18 | +- **Approver(s)** — Governance sign-off |
30 | 19 |
|
31 | 20 | --- |
32 | 21 |
|
33 | | -### 2025-09-12 — Deprecation |
34 | | -- **Verb(s):** `register` |
35 | | -- **Action:** Deprecated |
36 | | -- **Reason:** Overlaps semantically with `subscribe`; caused confusion. |
37 | | -- **Resolution:** Marked as deprecated. Remains valid until **2025-12-12**. |
38 | | - - Developers should migrate to `subscribe`. |
39 | | -- **Maintainers:** @nicole |
| 22 | +## Decision Log |
40 | 23 |
|
41 | | ---- |
| 24 | +> *(Initial release — no lifecycle changes yet)* |
42 | 25 |
|
43 | | -### 2025-09-22 — Removal |
44 | | -- **Verb(s):** `log` |
45 | | -- **Action:** Removed |
46 | | -- **Reason:** Completed the 90-day deprecation window. |
47 | | -- **Resolution:** Permanently removed from canonical verbs. |
48 | | -- **Maintainers:** @roman, @kai |
| 26 | +| Date | Verb(s) | Action | Reason | Resolution | Approver(s) | |
| 27 | +|------|---------|--------|--------|------------|-------------| |
| 28 | +| — | — | — | — | — | — | |
49 | 29 |
|
50 | 30 | --- |
51 | 31 |
|
52 | | -## Rules of Thumb |
| 32 | +## Policy |
53 | 33 |
|
54 | | -1. **No silent changes** — everything must be logged here. |
55 | | -2. **Stability first** — once a verb is stable, only replace if absolutely necessary. |
56 | | -3. **Deprecation window** — always give at least **90 days** before removal. |
57 | | -4. **Governance matters** — if there’s disagreement, it must be resolved before merging. |
| 34 | +1. No silent changes — **every** protocol semantic update goes here |
| 35 | +2. Minimum **90-day** deprecation before removal |
| 36 | +3. Changes requiring new schema version: |
| 37 | + - `$id` changes |
| 38 | + - Field contract changes |
| 39 | + - Meaning changes |
| 40 | +4. Governance Council **must** approve every entry |
| 41 | +5. Stability > speed |
58 | 42 |
|
59 | 43 | --- |
60 | 44 |
|
61 | | -Maintainers: Please update this file with every schema or verb decision. |
62 | | -If it’s not in `RESOLUTION.md`, it didn’t officially happen. |
63 | | - |
64 | | -## Links |
| 45 | +Maintainers should read before any merge: |
| 46 | +- `SPEC.md` |
| 47 | +- `GOVERNANCE.md` |
| 48 | +- `SECURITY_PROVENANCE.md` |
65 | 49 |
|
66 | | -- [SECURITY POLICY](./SECURITY.md) — responsible disclosure and vulnerability handling |
67 | | -- [RESOLUTION](./RESOLUTION.md) — governance and deprecation log |
68 | | -- [POLICY](./POLICY.md) — verbs and ENS binding rules |
69 | | -- [GOVERNANCE](./GOVERNANCE.md) — decision-making and multisig control |
| 50 | +**Status:** Stable · v1.0.0 locked |
0 commit comments