snxraven/bare-operating-system
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Further MD Fixes

Browse Source
This commit is contained in:
Raven Scott
2026-04-25 23:04:56 -04:00
parent b07bc38708
commit b9d3a8b17f
143 changed files with 1861 additions and 1861 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/ctx-api-versioning.md
+3 -3
View File
@@ -3,14 +3,14 @@
## Current version
- **`ctx.bareOsCtxApiVersion`** — semver string defined in [`bare-os-ctx-api.js`](../../packages/bare-os-booter/lib/bare-os-ctx-api.js).
- **`BARE_OS_REQUIRE_CTX_API_MIN**` / `**BARE_OS_BOOT_ABI_STRICT`** — guest kernel may refuse boot if the booter is too old (see [environment appendix §14](environment-and-posix-appendix.md#14-environment-variables-complete-list)).
- **`BARE_OS_REQUIRE_CTX_API_MIN`** / **`BARE_OS_BOOT_ABI_STRICT`** — guest kernel may refuse boot if the booter is too old (see [environment appendix §14](environment-and-posix-appendix.md#14-environment-variables-complete-list)).
## Rules for contributors
1. **Additive changes** (new optional `ctx` methods, new env passthrough keys) — bump **patch** when behavior is backward compatible for existing kernels.
2. **Breaking changes** (renamed methods, stricter required behavior, removed hooks) — bump **minor** or **major** per semver; update stock `kernel/init.js` and docs in the same change.
3. **Deprecation** — document in this file and in [`package-bare-os-booter.md`](package-bare-os-booter.md); keep a compatibility shim for at least one release when feasible.
4. **Protocol alignment** — capability words and wire formats belong in **`bare-os-protocol**`; bump `**BARE_OS_PROTOCOL_PACKAGE_VERSION`** consumers when wire or strict matrix changes.
4. **Protocol alignment** — capability words and wire formats belong in **`bare-os-protocol`**; bump **`BARE_OS_PROTOCOL_PACKAGE_VERSION`** consumers when wire or strict matrix changes.
## Release checklist (same PR as `ctx` edits)
@@ -18,7 +18,7 @@
2. Update [`developer-guide/02-the-context-object.md`](../../developer-guide/02-the-context-object.md) and [`bare-os-ctx.d.ts`](../../packages/bare-os-booter/lib/bare-os-ctx.d.ts) for any new fields or methods.
3. Run **`node scripts/gen-ctx-client-helper.mjs`** and refresh any consumer that vendors the emitted header.
4. Add or extend **`packages/bare-os-booter/test.js`** (and workspace tests) for behavior that must not regress.
5. Run root **`npm test**` so `**pretest`** (`verify-ctx-api-feature-bits`, `verify-bare-imports`, …) passes.
5. Run root **`npm test**` so **`pretest`** (`verify-ctx-api-feature-bits`, `verify-bare-imports`, …) passes.
## Related