feat: declare stability tier per package [closes #227]#279
Open
EmersonBraun wants to merge 1 commit intomainfrom
Open
feat: declare stability tier per package [closes #227]#279EmersonBraun wants to merge 1 commit intomainfrom
EmersonBraun wants to merge 1 commit intomainfrom
Conversation
Closes #227. Adds an explicit 'stability' tier and short rationale to every package.json under a new 'agentskit' field, with a matching shields.io badge in each package README. Tier map: stable (11) core, adapters, react, ink, cli, runtime, tools, skills, memory, rag, templates beta (3) observability, sandbox, eval Rationale per package stored in package.json 'agentskit.stabilityNote' for programmatic access (future 'agentskit doctor' uses this). Stability policy documented at docs/STABILITY.md with three tiers: stable — API frozen at the minor level; breaking changes need a major bump and a deprecation cycle beta — usable in production; breaking changes allowed in minor bumps with CHANGELOG notes experimental — disposable API; anything may change in any release Also documents the path to v1.0.0 at the project level and the rules for promoting or demoting a package between tiers. Readers can now tell at a glance from the README which packages are safe for production and which may still evolve. Refs #227 #211
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Every package now declares an explicit stability tier in
package.jsonunder a newagentskitfield, with a matching badge in each README.Closes #227. Pairs with the Manifesto (principle 1 — 'the core is sacred') and the six ADRs which pin the contracts each 'stable' package implements.
What changed
Every
package.json{ "name": "@agentskit/core", "agentskit": { "stability": "stable", "stabilityNote": "Sacred package. Contract-stable per ADRs 0001-0006." } }The
stabilityNoteis for future programmatic uses (e.g.,agentskit doctorcould warn when a beta package is used in a 'production' config).Every package README
A shields.io badge right under the title:
New
docs/STABILITY.mdFull policy doc explaining:
Tier map
stable(11)beta(3)Rationale for
betatrio@agentskit/observability— Observer contract is stable (RT9), but provider integrations (LangSmith, OpenTelemetry, PostHog) are still being rounded out@agentskit/sandbox— E2B backend works; WebContainer fallback is still experimental@agentskit/eval— core APIs stable, but richer metrics and reporters are coming in Phase 2/3Test plan
package.jsonfiles updated with matchingagentskitblocksdocs/STABILITY.mdrenders on GitHubpnpm test— 13 packages pass (ink fails due to pre-existing ink@7 / ink-testing-library@4 incompat fixed in foundation: manifesto, origin, governance templates, and Phase 0 planning docs #265; unchanged by this PR)Refs #227 #211