docs(sdk): sync README to v0.17.1 and add CONTRIBUTING.md - #104
Merged
Merged
Conversation
Latest release is v0.17.1 (2026-09-15). README was lagging: - Status banner said v0.16.4 - Roadmap marked v0.17 as planned (already shipped) Move v0.17.x to current with the actual shipped content (chain-setter Token, _GATE_CACHE staleness closure, lazy-export repair, CB lock unification, op_id mint-fresh, error-code map closure). Move OpenTelemetry / Redis queue / hardened init to v0.18 planned.
Examples repo already has one. SDK did not. Covers: - Dev setup (clone, venv, pip install -e .[dev]) - Tests (pytest, source-pin regression pattern reference) - Linting / types (ruff + mypy + pre-commit) - Conventional Commits + prefixes actually used in this repo - PR rules (one logical change, wire-shape changes need ADR reference) - Issue/defect naming and security pointer
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
What
Two docs-only changes on master:
v0.16.4→v0.17.1v0.17moved from planned → shipped with actual shipped content (chain-setter Token,_GATE_CACHEstaleness closure, CB lock unification sync+async, op_id mint-freshDEF-OPID-REUSE-HASH-MISMATCH, error-code map closureDEF-SDKT-004)v0.18row added: OpenTelemetry exporter, Redis-backed offline queue, hardened init contractWhy
README lagged 1 minor behind actual current release (v0.17.1 shipped 2026-09-15). Roadmap table said
v0.17was still planned when it had already shipped. CONTRIBUTING.md was missing on SDK whilenullrun-examplesalready has one — same voice/style.Wire-shape impact
None. Both commits touch markdown only — no code, no schema_version, no protocol change. Safe to merge without coordinating with backend.
How to verify
v0.17.1; roadmap table showsv0.17.xrow as(current) ✅ alphawith the actual shipped content.pytest -qandruff check src testsagainst current source to confirm CONTRIBUTING instructions are accurate.SECURITY.mdpoints at the org-level.github/SECURITY.md).Commits
458ebcbdocs(sdk): sync status banner to v0.17.1 and roadmapc0930f9docs(sdk): add CONTRIBUTING.md