docs: add local setup guide and ignore mdbook build output - #303
Conversation
|
Warning Review limit reached
Next review available in: 2 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)
✨ 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 |
PR Check Summary
CI will run: build, test, clippy, fmt, cargo-deny, DCO, semver. |
Signed-off-by: Aaniya <aaniyaatomar@gmail.com>
f1975d6 to
d7908ff
Compare
What
Adds a local development setup guide to CONTRIBUTING.md, plus a small drive-by fix to .gitignore.
Why
New contributors need a verified, working set of steps to get a local dev environment running. Closes #283 (double-check this issue number before posting).
How
mdbook build docsall produce clean, real output.mdbook buildgenerated adocs/book/output directory and some auto-generated stub chapter files (blank placeholders forSUMMARY.mdentries with no content yet). These were removed from the working tree and are not part of this PR.docs/book/to.gitignoreso future contributors following this guide don't accidentally commit build output.Checklist
cargo test --workspacepassescargo clippy --workspace -- -D warningspassescargo fmt --allappliedCHANGELOG.mdupdated (if user-facing change) — not applicable, docs-only change