docs: add stability policy (STABILITY.md) and link it across contributor docs#249
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughAdds a STABILITY.md stability policy and wires references into README, CONTRIBUTING, CHANGELOG, module docstrings, and docs to declare Tier A/B/C interface guarantees and related release/deprecation rules for v0.x. ChangesStability Policy Documentation for Production v0.x
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
|
Actionable comments posted: 0 |
|
Actionable comments posted: 0 |
…stability policies
Summary
STABILITY.md, defining Tier A (stable), Tier B (evolving), and Tier C (unstable) interfaces for operators and contributors.0.xtags onmain, including scheduled commands,/health/, env vars, schedule YAML,corepublic API, and cross-appsync_apiexports.README.md,CONTRIBUTING.md,docs/README.md,docs/Onboarding.md, anddocs/Core_public_API.md.github_activity_tracker/sync_api.pyandcppa_pinecone_sync/sync_api.pymodule docstrings.CHANGELOG.mdunder[Unreleased].Apps touched
docs/)github_activity_tracker(docstring only)cppa_pinecone_sync(docstring only)Test plan
python -m pytest(or scoped:python -m pytest <app>/tests) — N/Auv run pyright(if typed code changed) — N/Alint-imports(if imports or cross-app coupling changed) — N/ADocs / coupling
docs/updated (if behavior or ops changed)python scripts/generate_service_docs.pyrun (ifservices.pyorcore/protocols.pychanged) — N/ACloses #237
Summary by CodeRabbit