Repository navigation
Commit bbfb352
docs: add release-cutting process to AGENTS.md (#220)
* docs: add release-cutting process and breaking-change guidance to AGENTS.md
Document how versioning maps onto hardfork boundaries, what counts as
a breaking vs. non-breaking change given this repo's slot-parity and
stable-ABI invariants, the tag/branch/changelog steps to cut a
release, and best practices for draft releases.
Co-Authored-By: Claude <noreply@anthropic.com>
* docs: inline backport procedure in AGENTS.md instead of referencing a skill
The backport-loop skill is local tooling, not something every
contributor has — spell out the tip-to-tip diff, commit-mapping, and
cherry-pick/PR steps directly so the process stands on its own.
Co-Authored-By: Claude <noreply@anthropic.com>
* docs: make breaking-vs-non-breaking rules explicit for new errors on existing functions
The old wording ("adding a new error that doesn't collide with an
existing selector") read as if any new error were automatically
non-breaking. Add a caller-observable-behavior test up front, split
out the new-revert-path-on-an-existing-function case explicitly on
both sides, and add a worked example to remove the ambiguity.
Co-Authored-By: Claude <noreply@anthropic.com>
* docs: distinguish additive storage growth from moving existing slots
"Changing the storage slot layout for existing state" read as if any
layout change were breaking, but appending new ERC-7201 namespaced
state is additive and doesn't disturb existing slots (how Cobalt added
new policy slots without touching Beryl's layout). Only moving,
resizing, retyping, or reordering an already-shipped field's slot is
actually breaking.
Co-Authored-By: Claude <noreply@anthropic.com>
* docs: decouple version bumps from hardfork boundaries
The versioning rule tied MAJOR 1:1 to hardfork ordinals, which
contradicts the breaking-vs-non-breaking test in the same section:
Cobalt's actual changes (multiplier, seize, composite policies) are
all non-breaking by that test, so forcing v2.0.0 for it was wrong.
Switch to vMAJOR.MINOR.PATCH driven purely by the breaking test —
MINOR for a hardfork's frozen (additive) interface, MAJOR only for an
actual breaking change. Simplify branching to one ongoing branch per
MAJOR line, since MINOR/PATCH releases no longer need their own
branch or backport step; a second branch only appears once a breaking
change actually ships.
Co-Authored-By: Claude <noreply@anthropic.com>
* docs: tighten breaking-vs-non-breaking wording
Trim redundant explanatory clauses and merge overlapping revert-path
bullets now that the section no longer needs to argue against the old
hardfork-forces-MAJOR framing.
Co-Authored-By: Claude <noreply@anthropic.com>
* docs: drop the Backporting procedure from AGENTS.md
Not applicable yet: releases/vN.x tracks main by fast-forward until a
second MAJOR line actually exists, and none does. Document the detailed
cherry-pick/PR mechanics when that first happens instead of carrying an
untested procedure for a scenario that hasn't occurred.
Co-Authored-By: Claude <noreply@anthropic.com>
* docs: collapse Cutting releases into three subsections
Fold Branching model, Process, and Draft releases into one Drafting a
release list. The section is now just Major vs. minor, the Breaking
change test, and Drafting a release — same substance, less scaffolding.
Co-Authored-By: Claude <noreply@anthropic.com>
* docs: drop the breaking/non-breaking bullet lists and example
Keep the test itself as the operative rule; the enumerated cases and
worked example were redundant with it.
Co-Authored-By: Claude <noreply@anthropic.com>
---------
Co-authored-by: Claude <noreply@anthropic.com>1 parent be6d045 commit bbfb352
1 file changed
Lines changed: 46 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
86 | 86 | | |
87 | 87 | | |
88 | 88 | | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
89 | 135 | | |
90 | 136 | | |
91 | 137 | | |
| |||
0 commit comments