@tangle-network/agent-interface 0.56.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -158,6 +158,22 @@ The three code states are intentionally distinct:
|
|
|
158
158
|
- `{ kind: "no-op" }` means a proposer ran and returned no change.
|
|
159
159
|
- `{ kind: "git-patch" }` carries a non-empty binary Git diff whose resulting tree must be verified.
|
|
160
160
|
|
|
161
|
+
## Versioning
|
|
162
|
+
|
|
163
|
+
This package follows semantic versioning from 1.0.0.
|
|
164
|
+
|
|
165
|
+
- A minor release is additive. A new export, a new optional field, and a new member on an exported union are minor.
|
|
166
|
+
- A patch release is a fix. A behaviour correction that keeps every declared type is patch.
|
|
167
|
+
- A major release removes or narrows. A deleted export, a removed member, a narrowed type, and a new required field are major.
|
|
168
|
+
|
|
169
|
+
Declare this package with a caret range, and set the floor to the lowest minor you actually use.
|
|
170
|
+
A package that reads an export added in 1.4.0 declares `^1.4.0`, because `^1.0.0` lets a resolver keep 1.0.0.
|
|
171
|
+
A caret range admits every later additive minor without a consumer release.
|
|
172
|
+
Do not declare a single-generation window such as `>=1.4.0 <1.5.0`; that shape forces a coordinated release across every repository on each minor.
|
|
173
|
+
|
|
174
|
+
Write a `default` branch in every `switch` over an exported union.
|
|
175
|
+
An exhaustiveness check that assigns the remaining case to `never` fails when a minor adds a member, and this promise does not cover it.
|
|
176
|
+
|
|
161
177
|
## License
|
|
162
178
|
|
|
163
179
|
MIT
|