Skip to content

docs: freeze the rules.yaml field set for 1.0.0#62

Merged
DataDave-Dev merged 1 commit into
mainfrom
freeze-rule-fields
Jul 2, 2026
Merged

docs: freeze the rules.yaml field set for 1.0.0#62
DataDave-Dev merged 1 commit into
mainfrom
freeze-rule-fields

Conversation

@DataDave-Dev

Copy link
Copy Markdown
Owner

What & why

Last groundwork item on the path to 1.0.0: freeze the .bec/rules.yaml field set. Turns "these are the fields" into a committed, test-enforced contract, so from 1.0.0 on the schema only evolves under the deprecation policy.

Audit (before freezing)

Confirmed the nine fields are perfectly aligned across the codebase and docs — nothing missing or extra:

Source Fields
Rule model (rules.py) id, paths, check, exclude, intent, why_it_matters, rejected_alternatives, severity, target
_to_rule accepted keys same nine
usage.md Fields table same nine
rule_record (why/list --json) same nine

Plus the top-level schema_version and rules keys.

Changes

  • Test lock (tests/test_rules.py): test_rule_field_set_is_frozen asserts dataclasses.fields(Rule) equals the frozen set, so adding/removing a field breaks CI on purpose.
  • Docs (usage.md + .es): a "Stable field set" note tying the freeze to the deprecation policy.
  • README (+ .es): checklist items for freeze the field set and validate on real repos marked done.
  • CHANGELOG: [Unreleased] entry.

Path to 1.0.0 — groundwork complete ✅

  • 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.

After this merges, the remaining step is the release act itself: cut 1.0.0 (bump pyproject.toml, tag v1.0.0, let release.yml publish to npm + PyPI) and flip the classifier to Development Status :: 5 - Production/Stable.

Test plan

  • pytest — 253 passing (+1 for the field-set lock).
  • becwright's own pre-commit hook passes.

Declare the nine .bec/rules.yaml fields (id, paths, check, exclude, intent,
why_it_matters, rejected_alternatives, severity, target) stable as of
schema_version 1, and lock the set with a test so adding or removing a field
is a deliberate, reviewed break. From 1.0.0 on the field set only changes
under the deprecation policy. Documented in usage.md (+ .es); checklist items
for freezing the field set and validating on real repos marked done.

Completes the groundwork on the path to 1.0.0.
@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: 38 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: 9a80ea55-d41a-4ff0-91da-9a96d7adbe68

📥 Commits

Reviewing files that changed from the base of the PR and between 0536496 and 7fccd1f.

📒 Files selected for processing (6)
  • CHANGELOG.md
  • README.es.md
  • README.md
  • documentation/usage.es.md
  • documentation/usage.md
  • tests/test_rules.py
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch freeze-rule-fields

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 2b247c9 into main Jul 2, 2026
5 checks passed
@DataDave-Dev DataDave-Dev deleted the freeze-rule-fields branch July 2, 2026 17:11
@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