docs: state a deprecation policy for 1.0.0#60
Conversation
One minor of notice: anything in the public contract is deprecated with a warning for at least one minor release and removed only in the next major, so no 1.x upgrade breaks a rule file, bundle, or check script without notice. Stated user-facing in the README Stability & versioning section and operationally in documentation/releasing.md (both EN + ES).
|
Warning Review limit reached
Next review available in: 52 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
What & why
Fourth item on the path to
1.0.0: state a deprecation policy. Turns "we'll try not to break things" into a concrete, written commitment users and contributors can rely on.Policy — one minor of notice
From
1.0.0on, nothing in the public contract (therules.yamlschema,.bec.yamlbundle format, built-in check names/flags, CLI commands and exit codes,check --jsonshape, MCP signatures) is removed without a major bump of notice:So anything valid on
1.0stays valid across every1.x. Pin a version in CI and a1.xupgrade never breaks your rules, bundles, or check scripts without warning.Changes
README.md/README.es.md: Deprecation policy subsection under Stability & versioning; checklist item marked done.documentation/releasing.md/.es: a Compatibility section stating the operational rule for whoever cuts a release, cross-linked to the README.CHANGELOG.md:[Unreleased]entry.Path to 1.0.0 (state after this PR)
rules.yamlfield set.check --jsonshape.Test plan
pyteststill green (251) as a sanity check.