Skip to content

docs: promote contributing refresh to main - #378

Merged
plind-junior merged 3 commits into
mainfrom
test
Jul 6, 2026
Merged

docs: promote contributing refresh to main#378
plind-junior merged 3 commits into
mainfrom
test

Conversation

@plind-junior

Copy link
Copy Markdown
Member

promotes #377 to main: the contributing refresh (fixed escaped fences, real review flow, ci gate commands, four-site release checklist) plus the #376 readme fence nit. docs-only.

the old file had backslash-escaped code fences (every block rendered
as literal text on github), called vouch pre-1.0 (1.2.1 is out),
referenced empty issue templates, and carried none of the release
checklist claude.md points at.

restructured along the shape of a strong contributing doc: what
happens to your pr (automated review + ci + maintainer decision, base
on test), what we welcome, what we won't merge (now including the
out-of-scope list — saas mode, ungated writes, storage-format swaps),
before-opening checklist, the exact ci gate commands, test
expectations (incl. the four registration sites for a new kb.*
method), required pr contents, commit/title format with examples, and
the maintainer release checklist with all four version sites.

kept as-is: dev setup, env-var table, logging guidelines, style,
security reporting.
markdownlint md040 wants a language on the fence; matches how the
compile flow diagram was labelled after the #362 review.
docs(contributing): refresh around the actual review flow and gates
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 45 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: e983c32e-f27c-441f-9e8c-55e7d172c64a

📥 Commits

Reviewing files that changed from the base of the PR and between f30067b and 7ffb625.

📒 Files selected for processing (2)
  • CONTRIBUTING.md
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch test

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.

@github-actions github-actions Bot added docs documentation, specs, examples, and repo guidance size: XS less than 50 changed non-doc lines labels Jul 6, 2026
@plind-junior
plind-junior merged commit 865d568 into main Jul 6, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation, specs, examples, and repo guidance size: XS less than 50 changed non-doc lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant