docs: freeze the rules.yaml field set for 1.0.0#62
Conversation
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.
|
Warning Review limit reached
Next review available in: 38 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 (6)
✨ 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
Last groundwork item on the path to
1.0.0: freeze the.bec/rules.yamlfield set. Turns "these are the fields" into a committed, test-enforced contract, so from1.0.0on 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:
Rulemodel (rules.py)_to_ruleaccepted keysusage.mdFields tablerule_record(why/list --json)Plus the top-level
schema_versionandruleskeys.Changes
tests/test_rules.py):test_rule_field_set_is_frozenassertsdataclasses.fields(Rule)equals the frozen set, so adding/removing a field breaks CI on purpose.usage.md+.es): a "Stable field set" note tying the freeze to the deprecation policy..es): checklist items for freeze the field set and validate on real repos marked done.[Unreleased]entry.Path to 1.0.0 — groundwork complete ✅
rules.yamlfield set.check --jsonshape.After this merges, the remaining step is the release act itself: cut
1.0.0(bumppyproject.toml, tagv1.0.0, letrelease.ymlpublish to npm + PyPI) and flip the classifier toDevelopment Status :: 5 - Production/Stable.Test plan
pytest— 253 passing (+1 for the field-set lock).