docs: clarify allow_branch_types defaults are a superset of the spec - #509
Conversation
Addresses the review comment on #505: the options table now lists the full default (all 21 types including AI agent and bot prefixes) and the docs explicitly note that DEFAULT_BRANCH_TYPES is a superset of the Conventional Branch spec, with strict spec-only validation available via an explicit allow_branch_types setting. Closes #494
✅ Deploy Preview for commit-check ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
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 (2)
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 |
|
Summary
Follow-up to #505 (merged). Two documentation cleanups requested during review:
Fix the review comment on feat: allow docs, ci, test, refactor branches by default #505 — the options table in
docs/configuration.rstlisted only 14 of the 21 default branch types and omittedai,claude,codex,copilot,cursor,dependabot,renovatefrom the Default column. The Default column now lists the fullDEFAULT_BRANCH_TYPESlist.Make the spec deviation explicit —
DEFAULT_BRANCH_TYPESis a superset of the Conventional Branch spec: spec types (feature,bugfix,hotfix,release,chore) plus Conventional Commit types (build,ci,docs,perf,refactor,style,test) and AI/bot prefixes (ai,claude,codex,copilot,cursor,dependabot,renovate). The description column and both config examples (README +docs/configuration.rst) now state this explicitly, and point users toallow_branch_typesfor strict spec-only validation.Changes
README.md— comment aboveallow_branch_typesin the example configdocs/configuration.rst— full default list in the Options table; expanded description with spec-superset note; example config reformatted to match the README (multi-line) with a clarifying commentValidation
sphinx-build -E -b html docs _build/htmlsucceeds; no new warnings (existing 7 warnings are pre-existing inchangelog.rst/migration.rst)Closes #494