Skip to content

docs: state a deprecation policy for 1.0.0#60

Merged
DataDave-Dev merged 1 commit into
mainfrom
deprecation-policy
Jul 2, 2026
Merged

docs: state a deprecation policy for 1.0.0#60
DataDave-Dev merged 1 commit into
mainfrom
deprecation-policy

Conversation

@DataDave-Dev

Copy link
Copy Markdown
Owner

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.0 on, nothing in the public contract (the rules.yaml schema, .bec.yaml bundle format, built-in check names/flags, CLI commands and exit codes, check --json shape, MCP signatures) is removed without a major bump of notice:

  1. Marked deprecated in a minor — keeps working, emits a warning.
  2. Keeps working (still warning) through the rest of that major series.
  3. Removed only in the next major.

So anything valid on 1.0 stays valid across every 1.x. Pin a version in CI and a 1.x upgrade 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)

  • Version both on-disk formats.
  • Freeze the rules.yaml field set.
  • Document and stabilize CLI exit codes and the check --json shape.
  • State a deprecation policy.
  • Validate on real repositories beyond this one.

Test plan

  • Docs-only change; pytest still green (251) as a sanity check.
  • becwright's own pre-commit hook passes.

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).
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@DataDave-Dev, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 52 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: c9ffc432-f883-4dea-8a84-1581fc62b812

📥 Commits

Reviewing files that changed from the base of the PR and between 56359a5 and 3440512.

📒 Files selected for processing (5)
  • CHANGELOG.md
  • README.es.md
  • README.md
  • documentation/releasing.es.md
  • documentation/releasing.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch deprecation-policy

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@DataDave-Dev DataDave-Dev merged commit 0e3a06e into main Jul 2, 2026
5 checks passed
@DataDave-Dev DataDave-Dev deleted the deprecation-policy branch July 2, 2026 16:56
@DataDave-Dev DataDave-Dev mentioned this pull request Jul 2, 2026
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant